Class PipelineStageAction


  • public final class PipelineStageAction
    extends java.lang.Object
    • Method Detail

      • category

        public java.lang.String category()
        Returns:
        A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Possible values are `Approval`, `Build`, `Deploy`, `Invoke`, `Source`, `Compute` and `Test`.
      • commands

        public java.util.List<java.lang.String> commands()
        Returns:
        A list of shell commands to run with the compute action.
      • configuration

        public java.util.Map<java.lang.String,​java.lang.String> configuration()
        Returns:
        A map of the action declaration's configuration. Configurations options for action types and providers can be found in the [Pipeline Structure Reference](http://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#action-requirements) and [Action Structure Reference](https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference.html) documentation. Note: The `DetectChanges` parameter (optional, default value is true) in the `configuration` section causes CodePipeline to automatically start your pipeline upon new commits. Please refer to AWS Documentation for more details: https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference-CodestarConnectionSource.html#action-reference-CodestarConnectionSource-config.
      • inputArtifacts

        public java.util.List<java.lang.String> inputArtifacts()
        Returns:
        A list of artifact names to be worked on.
      • name

        public java.lang.String name()
        Returns:
        The action declaration's name.
      • namespace

        public java.util.Optional<java.lang.String> namespace()
        Returns:
        The namespace all output variables will be accessed from.
      • outputArtifacts

        public java.util.List<java.lang.String> outputArtifacts()
        Returns:
        A list of artifact names to output. Output artifact names must be unique within a pipeline. If the action is `Compute`, this argument is ignored.
      • outputArtifactsForComputeActions

        public java.util.List<PipelineStageActionOutputArtifactsForComputeAction> outputArtifactsForComputeActions()
        Returns:
        A block of output artifacts for the compute action. If the action is not `Compute`, this argument is ignored.
      • outputVariables

        public java.util.List<java.lang.String> outputVariables()
        Returns:
        A list of variables that are to be exported from the compute action.
      • owner

        public java.lang.String owner()
        Returns:
        The creator of the action being called. Possible values are `AWS`, `Custom` and `ThirdParty`.
      • provider

        public java.lang.String provider()
        Returns:
        The provider of the service being called by the action. Valid providers are determined by the action category. Provider names are listed in the [Action Structure Reference](https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference.html) documentation.
      • region

        public java.util.Optional<java.lang.String> region()
        Returns:
        The region in which to run the action.
      • roleArn

        public java.util.Optional<java.lang.String> roleArn()
        Returns:
        The ARN of the IAM service role that will perform the declared action. This is assumed through the roleArn for the pipeline.
      • runOrder

        public java.util.Optional<java.lang.Integer> runOrder()
        Returns:
        The order in which actions are run.
      • timeoutInMinutes

        public java.util.Optional<java.lang.Integer> timeoutInMinutes()
        Returns:
        The action timeout for the rule.
      • version

        public java.lang.String version()
        Returns:
        A string that identifies the action type.