Package software.amazon.awscdk.services.codepipeline

Interface CfnPipeline.ActionDeclarationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPipeline.ActionDeclarationProperty.Jsii$Proxy

Enclosing class:

CfnPipeline

@Stability(Stable)
public static interface CfnPipeline.ActionDeclarationProperty
extends software.amazon.jsii.JsiiSerializable

Represents information about an action declaration.

Documentation for the timeoutInMinutes parameter in the ActionDeclaration is not yet available for CloudFormation and CDK resources in CodePipeline. For more information about the configurable timeout for manual approval actions, see the ActionDeclaration in the CodePipeline API Reference.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.codepipeline.*;
 Object configuration;
 ActionDeclarationProperty actionDeclarationProperty = ActionDeclarationProperty.builder()
         .actionTypeId(ActionTypeIdProperty.builder()
                 .category("category")
                 .owner("owner")
                 .provider("provider")
                 .version("version")
                 .build())
         .name("name")
         // the properties below are optional
         .configuration(configuration)
         .inputArtifacts(List.of(InputArtifactProperty.builder()
                 .name("name")
                 .build()))
         .namespace("namespace")
         .outputArtifacts(List.of(OutputArtifactProperty.builder()
                 .name("name")
                 .build()))
         .region("region")
         .roleArn("roleArn")
         .runOrder(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-actiondeclaration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPipeline.ActionDeclarationProperty.Builder	A builder for CfnPipeline.ActionDeclarationProperty
static final class	CfnPipeline.ActionDeclarationProperty.Jsii$Proxy	An implementation for CfnPipeline.ActionDeclarationProperty

Method Summary

Modifier and Type	Method	Description
static CfnPipeline.ActionDeclarationProperty.Builder	builder()
Object	getActionTypeId()	Specifies the action type and the provider of the action.
default Object	getConfiguration()	The action's configuration.
default Object	getInputArtifacts()	The name or ID of the artifact consumed by the action, such as a test or build artifact.
String	getName()	The action declaration's name.
default String	getNamespace()	The variable namespace associated with the action.
default Object	getOutputArtifacts()	The name or ID of the result of the action declaration, such as a test or build artifact.
default String	getRegion()	The action declaration's AWS Region, such as us-east-1.
default String	getRoleArn()	The ARN of the IAM service role that performs the declared action.
default Number	getRunOrder()	The order in which actions are run.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getActionTypeId

@Stability(Stable)
@NotNull
Object getActionTypeId()

Specifies the action type and the provider of the action.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-actiondeclaration.html#cfn-codepipeline-pipeline-actiondeclaration-actiontypeid

getName

@Stability(Stable)
@NotNull
String getName()

The action declaration's name.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-actiondeclaration.html#cfn-codepipeline-pipeline-actiondeclaration-name

getConfiguration

@Stability(Stable)
@Nullable
default Object getConfiguration()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-actiondeclaration.html#cfn-codepipeline-pipeline-actiondeclaration-configuration

getInputArtifacts

@Stability(Stable)
@Nullable
default Object getInputArtifacts()

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

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-actiondeclaration.html#cfn-codepipeline-pipeline-actiondeclaration-inputartifacts

getNamespace

@Stability(Stable)
@Nullable
default String getNamespace()

The variable namespace associated with the action.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-actiondeclaration.html#cfn-codepipeline-pipeline-actiondeclaration-namespace

getOutputArtifacts

@Stability(Stable)
@Nullable
default Object getOutputArtifacts()

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

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-actiondeclaration.html#cfn-codepipeline-pipeline-actiondeclaration-outputartifacts

getRegion

@Stability(Stable)
@Nullable
default String getRegion()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-actiondeclaration.html#cfn-codepipeline-pipeline-actiondeclaration-region

getRoleArn

@Stability(Stable)
@Nullable
default String getRoleArn()

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

This is assumed through the roleArn for the pipeline.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-actiondeclaration.html#cfn-codepipeline-pipeline-actiondeclaration-rolearn

getRunOrder

@Stability(Stable)
@Nullable
default Number getRunOrder()

The order in which actions are run.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-actiondeclaration.html#cfn-codepipeline-pipeline-actiondeclaration-runorder

builder

@Stability(Stable)
static CfnPipeline.ActionDeclarationProperty.Builder builder()

Returns:

a CfnPipeline.ActionDeclarationProperty.Builder of CfnPipeline.ActionDeclarationProperty