Class CfnPipeline.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnPipeline>
- Enclosing class:
CfnPipeline
CfnPipeline
.-
Method Summary
Modifier and TypeMethodDescriptionartifactStore
(IResolvable artifactStore) The S3 bucket where artifacts for the pipeline are stored.artifactStore
(CfnPipeline.ArtifactStoreProperty artifactStore) The S3 bucket where artifacts for the pipeline are stored.artifactStores
(List<? extends Object> artifactStores) A mapping ofartifactStore
objects and their corresponding AWS Regions.artifactStores
(IResolvable artifactStores) A mapping ofartifactStore
objects and their corresponding AWS Regions.build()
static CfnPipeline.Builder
disableInboundStageTransitions
(List<? extends Object> disableInboundStageTransitions) Represents the input of aDisableStageTransition
action.disableInboundStageTransitions
(IResolvable disableInboundStageTransitions) Represents the input of aDisableStageTransition
action.executionMode
(String executionMode) The method that the pipeline will use to handle multiple executions.The name of the pipeline.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.restartExecutionOnUpdate
(Boolean restartExecutionOnUpdate) Indicates whether to rerun the CodePipeline pipeline after you update it.restartExecutionOnUpdate
(IResolvable restartExecutionOnUpdate) Indicates whether to rerun the CodePipeline pipeline after you update it.The Amazon Resource Name (ARN) for CodePipeline to use to either perform actions with noactionRoleArn
, or to use to assume roles for actions with anactionRoleArn
.Represents information about a stage and its definition.stages
(IResolvable stages) Represents information about a stage and its definition.Specifies the tags applied to the pipeline.The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.triggers
(IResolvable triggers) The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.A list that defines the pipeline variables for a pipeline resource.variables
(IResolvable variables) A list that defines the pipeline variables for a pipeline resource.
-
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
The Amazon Resource Name (ARN) for CodePipeline to use to either perform actions with noactionRoleArn
, or to use to assume roles for actions with anactionRoleArn
.- Parameters:
roleArn
- The Amazon Resource Name (ARN) for CodePipeline to use to either perform actions with noactionRoleArn
, or to use to assume roles for actions with anactionRoleArn
. This parameter is required.- Returns:
this
- See Also:
-
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:
-
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:
-
artifactStore
The S3 bucket where artifacts for the pipeline are stored.You must include either
artifactStore
orartifactStores
in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must useartifactStores
.- Parameters:
artifactStore
- The S3 bucket where artifacts for the pipeline are stored. This parameter is required.- Returns:
this
- See Also:
-
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
orartifactStores
in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must useartifactStores
.- Parameters:
artifactStore
- The S3 bucket where artifacts for the pipeline are stored. This parameter is required.- Returns:
this
- See Also:
-
artifactStores
A mapping ofartifactStore
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
orartifactStores
in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must useartifactStores
.- Parameters:
artifactStores
- A mapping ofartifactStore
objects and their corresponding AWS Regions. This parameter is required.- Returns:
this
- See Also:
-
artifactStores
A mapping ofartifactStore
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
orartifactStores
in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must useartifactStores
.- Parameters:
artifactStores
- A mapping ofartifactStore
objects and their corresponding AWS Regions. This parameter is required.- Returns:
this
- See Also:
-
disableInboundStageTransitions
@Stability(Stable) public CfnPipeline.Builder disableInboundStageTransitions(IResolvable disableInboundStageTransitions) Represents the input of aDisableStageTransition
action.- Parameters:
disableInboundStageTransitions
- Represents the input of aDisableStageTransition
action. This parameter is required.- Returns:
this
- See Also:
-
disableInboundStageTransitions
@Stability(Stable) public CfnPipeline.Builder disableInboundStageTransitions(List<? extends Object> disableInboundStageTransitions) Represents the input of aDisableStageTransition
action.- Parameters:
disableInboundStageTransitions
- Represents the input of aDisableStageTransition
action. This parameter is required.- Returns:
this
- See Also:
-
executionMode
The method that the pipeline will use to handle multiple executions.The default mode is SUPERSEDED.
Default: - "SUPERSEDED"
- Parameters:
executionMode
- The method that the pipeline will use to handle multiple executions. This parameter is required.- Returns:
this
- See Also:
-
name
The name of the pipeline.- Parameters:
name
- The name of the pipeline. This parameter is required.- Returns:
this
- See Also:
-
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:
-
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:
-
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:
-
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:
-
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:
-
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:
-
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:
-
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:
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnPipeline>
- Returns:
- a newly built instance of
CfnPipeline
.
-