Interface CfnPipelineProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnPipelineProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.89.0 (build 2f74b3e)",
date="2023-10-26T00:56:05.680Z")
@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)
.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()))
.name("name")
.restartExecutionOnUpdate(false)
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnPipelinePropsstatic final classAn implementation forCfnPipelineProps -
Method Summary
Modifier and TypeMethodDescriptionstatic CfnPipelineProps.Builderbuilder()default ObjectThe S3 bucket where artifacts for the pipeline are stored.default ObjectA mapping ofartifactStoreobjects and their corresponding AWS Regions.default ObjectRepresents the input of aDisableStageTransitionaction.default StringgetName()The name of the pipeline.default ObjectIndicates 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.getTags()Specifies the tags applied to the pipeline.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getRoleArn
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.- See Also:
-
getStages
Represents information about a stage and its definition.- See Also:
-
getArtifactStore
The S3 bucket where artifacts for the pipeline are stored.You must include either
artifactStoreorartifactStoresin your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must useartifactStores.- See Also:
-
getArtifactStores
A mapping ofartifactStoreobjects 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
artifactStoreorartifactStoresin your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must useartifactStores.- See Also:
-
getDisableInboundStageTransitions
Represents the input of aDisableStageTransitionaction.- See Also:
-
getName
The name of the pipeline.- See Also:
-
getRestartExecutionOnUpdate
Indicates whether to rerun the CodePipeline pipeline after you update it.- See Also:
-
getTags
Specifies the tags applied to the pipeline.- See Also:
-
builder
- Returns:
- a
CfnPipelineProps.BuilderofCfnPipelineProps
-