Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ActionDeclaration

Represents information about an action declaration.

Hierarchy

  • ActionDeclaration

Index

Properties

actionTypeId

actionTypeId: ActionTypeId | undefined

Specifies the action type and the provider of the action.

Optional configuration

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 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 },

Optional inputArtifacts

inputArtifacts: InputArtifact[]

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

name

name: string | undefined

The action declaration's name.

Optional namespace

namespace: undefined | string

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

Optional outputArtifacts

outputArtifacts: OutputArtifact[]

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

Optional region

region: undefined | string

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

Optional roleArn

roleArn: undefined | string

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

Optional runOrder

runOrder: undefined | number

The order in which actions are run.