software.amazon.awscdk.services.codepipeline

Interface CfnPipeline.ActionDeclarationProperty

All Known Implementing Classes:

CfnPipeline.ActionDeclarationProperty.Jsii$Proxy

Enclosing class:

CfnPipeline

public static interface CfnPipeline.ActionDeclarationProperty

Represents information about an action declaration.

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();
 

Nested Class Summary

Nested Classes

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

Method Summary

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

Method Detail

getActionTypeId

java.lang.Object getActionTypeId()

Specifies the action type and the provider of the action.

getName

java.lang.String getName()

The action declaration's name.

getConfiguration

default java.lang.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 },

getInputArtifacts

default java.lang.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 .

getNamespace

default java.lang.String getNamespace()

The variable namespace associated with the action.

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

getOutputArtifacts

default java.lang.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 .

getRegion

default java.lang.String getRegion()

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

getRoleArn

default java.lang.String getRoleArn()

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

This is assumed through the roleArn for the pipeline.

getRunOrder

default java.lang.Number getRunOrder()

The order in which actions are run.

builder

static CfnPipeline.ActionDeclarationProperty.Builder builder()

Returns:

a CfnPipeline.ActionDeclarationProperty.Builder of CfnPipeline.ActionDeclarationProperty