ActionDeclaration
Represents information about an action declaration.
Contents
- actionTypeId
-
Specifies the action type and the provider of the action.
Type: ActionTypeId object
Required: Yes
- name
-
The action declaration's name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[A-Za-z0-9.@\-_]+Required: Yes
- commands
-
The shell commands to run with your compute action in CodePipeline. All commands are supported except multi-line formats. While CodeBuild logs and permissions are used, you do not need to create any resources in CodeBuild.
Note
Using compute time for this action will incur separate charges in AWS CodeBuild.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 50 items.
Length Constraints: Minimum length of 1. Maximum length of 1000.
Required: No
- 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 },Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 50.
Value Length Constraints: Minimum length of 1. Maximum length of 1000.
Required: No
- environmentVariables
-
The environment variables for the action.
Type: Array of EnvironmentVariable objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: No
- inputArtifacts
-
The name or ID of the artifact consumed by the action, such as a test or build artifact.
Type: Array of InputArtifact objects
Required: No
- namespace
-
The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[A-Za-z0-9@\-_]+Required: No
- outputArtifacts
-
The name or ID of the result of the action declaration, such as a test or build artifact.
Type: Array of OutputArtifact objects
Required: No
- outputVariables
-
The list of variables that are to be exported from the compute action. This is specifically CodeBuild environment variables as used for that action.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 15 items.
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: No
- region
-
The action declaration's AWS Region, such as us-east-1.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 30.
Required: No
- roleArn
-
The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.
Type: String
Length Constraints: Maximum length of 1024.
Pattern:
arn:aws(-[\w]+)*:iam::[0-9]{12}:role/.*Required: No
- runOrder
-
The order in which actions are run.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 999.
Required: No
- timeoutInMinutes
-
A timeout duration in minutes that can be applied against the ActionType’s default timeout value specified in Quotas for AWS CodePipeline. This attribute is available only to the manual approval ActionType.
Type: Integer
Valid Range: Minimum value of 5. Maximum value of 86400.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
