aws-cdk-lib.aws_codepipeline.CfnPipeline.ActionDeclarationProperty

ActionDeclarationProperty Struct

Represents information about an action declaration.

Source

Generated code

Type last changed

v2.195.0 · 7 May 2025

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_codepipeline as codepipeline } from 'aws-cdk-lib';

declare const configuration: any;
const actionDeclarationProperty: codepipeline.CfnPipeline.ActionDeclarationProperty = {
  actionTypeId: {
    category: 'category',
    owner: 'owner',
    provider: 'provider',
    version: 'version',
  },
  name: 'name',

  // the properties below are optional
  commands: ['commands'],
  configuration: configuration,
  environmentVariables: [{
    name: 'name',
    value: 'value',

    // the properties below are optional
    type: 'type',
  }],
  inputArtifacts: [{
    name: 'name',
  }],
  namespace: 'namespace',
  outputArtifacts: [{
    name: 'name',

    // the properties below are optional
    files: ['files'],
  }],
  outputVariables: ['outputVariables'],
  region: 'region',
  roleArn: 'roleArn',
  runOrder: 123,
  timeoutInMinutes: 123,
};

Properties

actionTypeIdIResolvable | CfnPipeline.ActionTypeIdPropertyaction_type_idtyping.Union[IResolvable, ActionTypeIdProperty]actionTypeIdIResolvableActionTypeIdIResolvableActionTypeIdinterface{}required#

Specifies the action type and the provider of the action.

commandsstring[]commandstyping.List[str]commandsList<String>Commandsstring[]Commands*[]*string#

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.

Using compute time for this action will incur separate charges in AWS CodeBuild .

configurationanyconfigurationAnyconfigurationObjectConfigurationobjectConfigurationinterface{}#

The action's configuration.

notes

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

environmentVariablesIResolvable | IResolvable | CfnPipeline.EnvironmentVariableProperty[]environment_variablestyping.Union[IResolvable, typing.List[typing.Union[IResolvable, EnvironmentVariableProperty]]]environmentVariablesIResolvableEnvironmentVariablesIResolvableEnvironmentVariablesinterface{}#

The environment variables for the action.

inputArtifactsIResolvable | IResolvable | CfnPipeline.InputArtifactProperty[]input_artifactstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, InputArtifactProperty]]]inputArtifactsIResolvableInputArtifactsIResolvableInputArtifactsinterface{}#

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

notes

While the field is not a required parameter, most actions have an action configuration that requires a specified quantity of input artifacts. To refer to the action configuration specification by action provider, see the Action structure reference in the AWS CodePipeline User Guide .

For a CodeBuild action with multiple input artifacts, one of your input sources must be designated the PrimarySource. For more information, see the CodeBuild action reference page in the AWS CodePipeline User Guide .

namestringnamestrnameStringNamestringName*stringrequired#

The action declaration's name.

namespacestringnamespacestrnamespaceStringNamespacestringNamespace*string#

The variable namespace associated with the action.

All variables produced as output by this action fall under this namespace.

outputArtifactsIResolvable | IResolvable | CfnPipeline.OutputArtifactProperty[]output_artifactstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, OutputArtifactProperty]]]outputArtifactsIResolvableOutputArtifactsIResolvableOutputArtifactsinterface{}#

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

notes

While the field is not a required parameter, most actions have an action configuration that requires a specified quantity of output artifacts. To refer to the action configuration specification by action provider, see the Action structure reference in the AWS CodePipeline User Guide .

outputVariablesstring[]output_variablestyping.List[str]outputVariablesList<String>OutputVariablesstring[]OutputVariables*[]*string#

The list of variables that are to be exported from the compute action.

This is specifically CodeBuild environment variables as used for that action.

regionstringregionstrregionStringRegionstringRegion*string#

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

roleArnstringrole_arnstrroleArnStringRoleArnstringRoleArn*string#

The ARN of the IAM service role that performs the declared action.

This is assumed through the roleArn for the pipeline.

runOrdernumberrun_orderint | floatrunOrderNumberRunOrderdoubleRunOrder*float64#

The order in which actions are run.

timeoutInMinutesnumbertimeout_in_minutesint | floattimeoutInMinutesNumberTimeoutInMinutesdoubleTimeoutInMinutes*float64#

A timeout duration in minutes that can be applied against the ActionType’s default timeout value specified in [Quotas for AWS CodePipeline](https://docs.aws.amazon.com/codepipeline/latest/userguide/limits.html) . This attribute is available only to the manual approval ActionType.