class Aws::CodePipeline::Types::ActionDeclaration
Represents information about an action declaration.
@note When making an API call, you may pass ActionDeclaration
data as a hash: { name: "ActionName", # required action_type_id: { # required category: "Source", # required, accepts Source, Build, Deploy, Test, Invoke, Approval owner: "AWS", # required, accepts AWS, ThirdParty, Custom provider: "ActionProvider", # required version: "Version", # required }, run_order: 1, configuration: { "ActionConfigurationKey" => "ActionConfigurationValue", }, output_artifacts: [ { name: "ArtifactName", # required }, ], input_artifacts: [ { name: "ArtifactName", # required }, ], role_arn: "RoleArn", region: "AWSRegionName", namespace: "ActionNamespace", }
@!attribute [rw] name
The action declaration's name. @return [String]
@!attribute [rw] action_type_id
Specifies the action type and the provider of the action. @return [Types::ActionTypeId]
@!attribute [rw] run_order
The order in which actions are run. @return [Integer]
@!attribute [rw] 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][1]. For the list of configuration properties for the AWS CloudFormation action type in CodePipeline, see [Configuration Properties Reference][2] in the *AWS CloudFormation User Guide*. For template snippets with examples, see [Using Parameter Override Functions with CodePipeline Pipelines][3] 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 \},` [1]: https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#action-requirements [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/continuous-delivery-codepipeline-action-reference.html [3]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/continuous-delivery-codepipeline-parameter-override-functions.html @return [Hash<String,String>]
@!attribute [rw] output_artifacts
The name or ID of the result of the action declaration, such as a test or build artifact. @return [Array<Types::OutputArtifact>]
@!attribute [rw] input_artifacts
The name or ID of the artifact consumed by the action, such as a test or build artifact. @return [Array<Types::InputArtifact>]
@!attribute [rw] role_arn
The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline. @return [String]
@!attribute [rw] region
The action declaration's AWS Region, such as us-east-1. @return [String]
@!attribute [rw] namespace
The variable namespace associated with the action. All variables produced as output by this action fall under this namespace. @return [String]
@see docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/ActionDeclaration AWS API Documentation
Constants
- SENSITIVE