Package software.amazon.awscdk.services.codepipeline

Class CfnPipeline.Builder

java.lang.Object

software.amazon.awscdk.services.codepipeline.CfnPipeline.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnPipeline>

Enclosing class:

CfnPipeline

@Stability(Stable)
public static final class CfnPipeline.Builder
extends Object
implements software.amazon.jsii.Builder<CfnPipeline>

A fluent builder for CfnPipeline.

Method Summary

Modifier and Type	Method	Description
CfnPipeline.Builder	artifactStore(IResolvable artifactStore)	The S3 bucket where artifacts for the pipeline are stored.
CfnPipeline.Builder	artifactStore(CfnPipeline.ArtifactStoreProperty artifactStore)	The S3 bucket where artifacts for the pipeline are stored.
CfnPipeline.Builder	artifactStores(List<? extends Object> artifactStores)	A mapping of artifactStore objects and their corresponding AWS Regions.
CfnPipeline.Builder	artifactStores(IResolvable artifactStores)	A mapping of artifactStore objects and their corresponding AWS Regions.
CfnPipeline	build()
static CfnPipeline.Builder	create(software.constructs.Construct scope, String id)
CfnPipeline.Builder	disableInboundStageTransitions(List<? extends Object> disableInboundStageTransitions)	Represents the input of a DisableStageTransition action.
CfnPipeline.Builder	disableInboundStageTransitions(IResolvable disableInboundStageTransitions)	Represents the input of a DisableStageTransition action.
CfnPipeline.Builder	executionMode(String executionMode)	The method that the pipeline will use to handle multiple executions.
CfnPipeline.Builder	name(String name)	The name of the pipeline.
CfnPipeline.Builder	pipelineType(String pipelineType)	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.
CfnPipeline.Builder	restartExecutionOnUpdate(Boolean restartExecutionOnUpdate)	Indicates whether to rerun the CodePipeline pipeline after you update it.
CfnPipeline.Builder	restartExecutionOnUpdate(IResolvable restartExecutionOnUpdate)	Indicates whether to rerun the CodePipeline pipeline after you update it.
CfnPipeline.Builder	roleArn(String roleArn)	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 .
CfnPipeline.Builder	stages(List<? extends Object> stages)	Represents information about a stage and its definition.
CfnPipeline.Builder	stages(IResolvable stages)	Represents information about a stage and its definition.
CfnPipeline.Builder	tags(List<? extends CfnTag> tags)	Specifies the tags applied to the pipeline.
CfnPipeline.Builder	triggers(List<? extends Object> triggers)	The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.
CfnPipeline.Builder	triggers(IResolvable triggers)	The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.
CfnPipeline.Builder	variables(List<? extends Object> variables)	A list that defines the pipeline variables for a pipeline resource.
CfnPipeline.Builder	variables(IResolvable variables)	A list that defines the pipeline variables for a pipeline resource.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnPipeline.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnPipeline.Builder.

roleArn

@Stability(Stable)
public CfnPipeline.Builder roleArn(String roleArn)

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 .

Parameters:

roleArn - 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 . This parameter is required.

Returns:

this

See Also:

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

stages

@Stability(Stable)
public CfnPipeline.Builder stages(IResolvable stages)

Represents information about a stage and its definition.

Parameters:

stages - Represents information about a stage and its definition. This parameter is required.

Returns:

this

See Also:

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

stages

@Stability(Stable)
public CfnPipeline.Builder stages(List<? extends Object> stages)

Represents information about a stage and its definition.

Parameters:

stages - Represents information about a stage and its definition. This parameter is required.

Returns:

this

See Also:

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

artifactStore

@Stability(Stable)
public CfnPipeline.Builder artifactStore(IResolvable artifactStore)

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 .

Parameters:

artifactStore - The S3 bucket where artifacts for the pipeline are stored. This parameter is required.

Returns:

this

See Also:

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

artifactStore

@Stability(Stable)
public CfnPipeline.Builder artifactStore(CfnPipeline.ArtifactStoreProperty artifactStore)

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 .

Parameters:

artifactStore - The S3 bucket where artifacts for the pipeline are stored. This parameter is required.

Returns:

this

See Also:

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

artifactStores

@Stability(Stable)
public CfnPipeline.Builder artifactStores(IResolvable artifactStores)

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 .

Parameters:

artifactStores - A mapping of artifactStore objects and their corresponding AWS Regions. This parameter is required.

Returns:

this

See Also:

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

artifactStores

@Stability(Stable)
public CfnPipeline.Builder artifactStores(List<? extends Object> artifactStores)

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 .

Parameters:

artifactStores - A mapping of artifactStore objects and their corresponding AWS Regions. This parameter is required.

Returns:

this

See Also:

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

disableInboundStageTransitions

@Stability(Stable)
public CfnPipeline.Builder disableInboundStageTransitions(IResolvable disableInboundStageTransitions)

Represents the input of a DisableStageTransition action.

Parameters:

disableInboundStageTransitions - Represents the input of a DisableStageTransition action. This parameter is required.

Returns:

this

See Also:

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

disableInboundStageTransitions

@Stability(Stable)
public CfnPipeline.Builder disableInboundStageTransitions(List<? extends Object> disableInboundStageTransitions)

Represents the input of a DisableStageTransition action.

Parameters:

disableInboundStageTransitions - Represents the input of a DisableStageTransition action. This parameter is required.

Returns:

this

See Also:

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

executionMode

@Stability(Stable)
public CfnPipeline.Builder executionMode(String executionMode)

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

The default mode is SUPERSEDED.

Parameters:

executionMode - The method that the pipeline will use to handle multiple executions. This parameter is required.

Returns:

this

See Also:

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

name

@Stability(Stable)
public CfnPipeline.Builder name(String name)

The name of the pipeline.

Parameters:

name - The name of the pipeline. This parameter is required.

Returns:

this

See Also:

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

pipelineType

@Stability(Stable)
public CfnPipeline.Builder pipelineType(String pipelineType)

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? .

Parameters:

pipelineType - 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. This parameter is required.

Returns:

this

See Also:

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

restartExecutionOnUpdate

@Stability(Stable)
public CfnPipeline.Builder restartExecutionOnUpdate(Boolean restartExecutionOnUpdate)

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

Parameters:

restartExecutionOnUpdate - Indicates whether to rerun the CodePipeline pipeline after you update it. This parameter is required.

Returns:

this

See Also:

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

restartExecutionOnUpdate

@Stability(Stable)
public CfnPipeline.Builder restartExecutionOnUpdate(IResolvable restartExecutionOnUpdate)

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

Parameters:

restartExecutionOnUpdate - Indicates whether to rerun the CodePipeline pipeline after you update it. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnPipeline.Builder tags(List<? extends CfnTag> tags)

Specifies the tags applied to the pipeline.

Parameters:

tags - Specifies the tags applied to the pipeline. This parameter is required.

Returns:

this

See Also:

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

triggers

@Stability(Stable)
public CfnPipeline.Builder triggers(IResolvable triggers)

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.

Parameters:

triggers - The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline. This parameter is required.

Returns:

this

See Also:

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

triggers

@Stability(Stable)
public CfnPipeline.Builder triggers(List<? extends Object> triggers)

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.

Parameters:

triggers - The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline. This parameter is required.

Returns:

this

See Also:

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

variables

@Stability(Stable)
public CfnPipeline.Builder variables(IResolvable variables)

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@\-_]+ .

Parameters:

variables - A list that defines the pipeline variables for a pipeline resource. This parameter is required.

Returns:

this

See Also:

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

variables

@Stability(Stable)
public CfnPipeline.Builder variables(List<? extends Object> variables)

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@\-_]+ .

Parameters:

variables - A list that defines the pipeline variables for a pipeline resource. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnPipeline build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnPipeline>

Returns:

a newly built instance of CfnPipeline.