Documentation

Represents information about an action declaration.

See: newActionDeclaration smart constructor.

Create a value of ActionDeclaration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:outputArtifacts:ActionDeclaration', actionDeclaration_outputArtifacts - The name or ID of the result of the action declaration, such as a test or build artifact.

$sel:namespace:ActionDeclaration', actionDeclaration_namespace - The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.

$sel:runOrder:ActionDeclaration', actionDeclaration_runOrder - The order in which actions are run.

$sel:region:ActionDeclaration', actionDeclaration_region - The action declaration's AWS Region, such as us-east-1.

$sel:configuration:ActionDeclaration', actionDeclaration_configuration - The action's configuration. These are key-value pairs that specify input values for an action. For more information, see Action Structure Requirements in CodePipeline. For the list of configuration properties for the AWS CloudFormation action type in CodePipeline, see Configuration Properties Reference in the AWS CloudFormation User Guide. For template snippets with examples, see Using Parameter Override Functions with CodePipeline Pipelines in the AWS CloudFormation User Guide.

The values can be represented in either JSON or YAML format. For example, the JSON configuration item format is as follows:

JSON:

"Configuration" : { Key : Value },

$sel:inputArtifacts:ActionDeclaration', actionDeclaration_inputArtifacts - The name or ID of the artifact consumed by the action, such as a test or build artifact.

$sel:roleArn:ActionDeclaration', actionDeclaration_roleArn - The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.

$sel:name:ActionDeclaration', actionDeclaration_name - The action declaration's name.

$sel:actionTypeId:ActionDeclaration', actionDeclaration_actionTypeId - Specifies the action type and the provider of the action.

The name or ID of the result of the action declaration, such as a test or build artifact.

The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.

The order in which actions are run.

The action declaration's AWS Region, such as us-east-1.

The action's configuration. These are key-value pairs that specify input values for an action. For more information, see Action Structure Requirements in CodePipeline. For the list of configuration properties for the AWS CloudFormation action type in CodePipeline, see Configuration Properties Reference in the AWS CloudFormation User Guide. For template snippets with examples, see Using Parameter Override Functions with CodePipeline Pipelines in the AWS CloudFormation User Guide.

The values can be represented in either JSON or YAML format. For example, the JSON configuration item format is as follows:

JSON:

"Configuration" : { Key : Value },

The name or ID of the artifact consumed by the action, such as a test or build artifact.

The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.

The action declaration's name.

Specifies the action type and the provider of the action.