Package software.amazon.awscdk.services.codepipeline

Interface CfnPipelineProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPipelineProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-18T17:54:14.290Z")
@Stability(Stable)
public interface CfnPipelineProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnPipeline.

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;
 CfnPipelineProps cfnPipelineProps = CfnPipelineProps.builder()
         .roleArn("roleArn")
         .stages(List.of(StageDeclarationProperty.builder()
                 .actions(List.of(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)
                         .timeoutInMinutes(123)
                         .build()))
                 .name("name")
                 // the properties below are optional
                 .blockers(List.of(BlockerDeclarationProperty.builder()
                         .name("name")
                         .type("type")
                         .build()))
                 .build()))
         // the properties below are optional
         .artifactStore(ArtifactStoreProperty.builder()
                 .location("location")
                 .type("type")
                 // the properties below are optional
                 .encryptionKey(EncryptionKeyProperty.builder()
                         .id("id")
                         .type("type")
                         .build())
                 .build())
         .artifactStores(List.of(ArtifactStoreMapProperty.builder()
                 .artifactStore(ArtifactStoreProperty.builder()
                         .location("location")
                         .type("type")
                         // the properties below are optional
                         .encryptionKey(EncryptionKeyProperty.builder()
                                 .id("id")
                                 .type("type")
                                 .build())
                         .build())
                 .region("region")
                 .build()))
         .disableInboundStageTransitions(List.of(StageTransitionProperty.builder()
                 .reason("reason")
                 .stageName("stageName")
                 .build()))
         .executionMode("executionMode")
         .name("name")
         .pipelineType("pipelineType")
         .restartExecutionOnUpdate(false)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .triggers(List.of(PipelineTriggerDeclarationProperty.builder()
                 .providerType("providerType")
                 // the properties below are optional
                 .gitConfiguration(GitConfigurationProperty.builder()
                         .sourceActionName("sourceActionName")
                         // the properties below are optional
                         .pullRequest(List.of(GitPullRequestFilterProperty.builder()
                                 .branches(GitBranchFilterCriteriaProperty.builder()
                                         .excludes(List.of("excludes"))
                                         .includes(List.of("includes"))
                                         .build())
                                 .events(List.of("events"))
                                 .filePaths(GitFilePathFilterCriteriaProperty.builder()
                                         .excludes(List.of("excludes"))
                                         .includes(List.of("includes"))
                                         .build())
                                 .build()))
                         .push(List.of(GitPushFilterProperty.builder()
                                 .branches(GitBranchFilterCriteriaProperty.builder()
                                         .excludes(List.of("excludes"))
                                         .includes(List.of("includes"))
                                         .build())
                                 .filePaths(GitFilePathFilterCriteriaProperty.builder()
                                         .excludes(List.of("excludes"))
                                         .includes(List.of("includes"))
                                         .build())
                                 .tags(GitTagFilterCriteriaProperty.builder()
                                         .excludes(List.of("excludes"))
                                         .includes(List.of("includes"))
                                         .build())
                                 .build()))
                         .build())
                 .build()))
         .variables(List.of(VariableDeclarationProperty.builder()
                 .name("name")
                 // the properties below are optional
                 .defaultValue("defaultValue")
                 .description("description")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnPipelineProps.Builder	builder()
default Object	getArtifactStore()	The S3 bucket where artifacts for the pipeline are stored.
default Object	getArtifactStores()	A mapping of artifactStore objects and their corresponding AWS Regions.
default Object	getDisableInboundStageTransitions()	Represents the input of a DisableStageTransition action.
default String	getExecutionMode()	The method that the pipeline will use to handle multiple executions.
default String	getName()	The name of the pipeline.
default String	getPipelineType()	CodePipeline provides the following pipeline types, which differ in characteristics and price, so that you can tailor your pipeline features and cost to the needs of your applications.
default Object	getRestartExecutionOnUpdate()	Indicates whether to rerun the CodePipeline pipeline after you update it.
String	getRoleArn()	The Amazon Resource Name (ARN) for CodePipeline to use to either perform actions with no actionRoleArn , or to use to assume roles for actions with an actionRoleArn .
Object	getStages()	Represents information about a stage and its definition.
default List<CfnTag>	getTags()	Specifies the tags applied to the pipeline.
default Object	getTriggers()	The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.
default Object	getVariables()	A list that defines the pipeline variables for a pipeline resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

The Amazon Resource Name (ARN) for CodePipeline to use to either perform actions with no actionRoleArn , or to use to assume roles for actions with an actionRoleArn .

See Also:

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

getStages

@Stability(Stable)
@NotNull
Object getStages()

Represents information about a stage and its definition.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-stages

getArtifactStore

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

The S3 bucket where artifacts for the pipeline are stored.

You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-artifactstore

getArtifactStores

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

A mapping of artifactStore objects and their corresponding AWS Regions.

There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline.

You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-artifactstores

getDisableInboundStageTransitions

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

Represents the input of a DisableStageTransition action.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-disableinboundstagetransitions

getExecutionMode

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

The method that the pipeline will use to handle multiple executions.

The default mode is SUPERSEDED.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-executionmode

getName

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

The name of the pipeline.

See Also:

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

getPipelineType

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

CodePipeline provides the following pipeline types, which differ in characteristics and price, so that you can tailor your pipeline features and cost to the needs of your applications.

• V1 type pipelines have a JSON structure that contains standard pipeline, stage, and action-level parameters.
• V2 type pipelines have the same structure as a V1 type, along with additional parameters for release safety and trigger configuration.

Including V2 parameters, such as triggers on Git tags, in the pipeline JSON when creating or updating a pipeline will result in the pipeline having the V2 type of pipeline and the associated costs.

For information about pricing for CodePipeline, see Pricing .

For information about which type of pipeline to choose, see What type of pipeline is right for me? .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-pipelinetype

getRestartExecutionOnUpdate

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

Indicates whether to rerun the CodePipeline pipeline after you update it.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-restartexecutiononupdate

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

Specifies the tags applied to the pipeline.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-tags

getTriggers

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

The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.

When a trigger configuration is specified, default change detection for repository and branch commits is disabled.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-triggers

getVariables

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

A list that defines the pipeline variables for a pipeline resource.

Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9@\-_]+ .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-variables

builder

@Stability(Stable)
static CfnPipelineProps.Builder builder()

Returns:

a CfnPipelineProps.Builder of CfnPipelineProps