Jump to Content

New API Documentation - Developer Preview Available

We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.

Interface ActionDeclaration

Represents information about an action declaration.


  • ActionDeclaration


actionTypeId: undefined | ActionTypeId

Specifies the action type and the provider of the action.

configuration?: Record<string, string>

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 CloudFormation action type in CodePipeline, see Configuration Properties Reference in the CloudFormation User Guide. For template snippets with examples, see Using Parameter Override Functions with CodePipeline Pipelines in the CloudFormation User Guide.

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


"Configuration" : { Key : Value },

inputArtifacts?: InputArtifact[]

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

name: undefined | string

The action declaration's name.

namespace?: string

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

outputArtifacts?: OutputArtifact[]

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

region?: string

The action declaration's Amazon Web Services Region, such as us-east-1.

roleArn?: string

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

runOrder?: number

The order in which actions are run.