@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:41.847Z") public class CfnPipeline extends CfnResource implements IInspectable
The AWS::CodePipeline::Pipeline
resource creates a CodePipeline pipeline that describes how software changes go through a release process. For more information, see What Is CodePipeline? in the AWS CodePipeline User Guide .
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; CfnPipeline cfnPipeline = CfnPipeline.Builder.create(this, "MyCfnPipeline") .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();
Modifier and Type | Class and Description |
---|---|
static interface |
CfnPipeline.ActionDeclarationProperty
Represents information about an action declaration.
|
static interface |
CfnPipeline.ActionTypeIdProperty
Represents information about an action type.
|
static interface |
CfnPipeline.ArtifactStoreMapProperty
A mapping of `artifactStore` objects and their corresponding AWS Regions.
|
static interface |
CfnPipeline.ArtifactStoreProperty
The S3 bucket where artifacts for the pipeline are stored.
|
static interface |
CfnPipeline.BlockerDeclarationProperty
Reserved for future use.
|
static class |
CfnPipeline.Builder
A fluent builder for
CfnPipeline . |
static interface |
CfnPipeline.EncryptionKeyProperty
Represents information about the key used to encrypt data in the artifact store, such as an AWS Key Management Service ( AWS KMS) key.
|
static interface |
CfnPipeline.InputArtifactProperty
Represents information about an artifact to be worked on, such as a test or build artifact.
|
static interface |
CfnPipeline.OutputArtifactProperty
Represents information about the output of an action.
|
static interface |
CfnPipeline.StageDeclarationProperty
Represents information about a stage and its definition.
|
static interface |
CfnPipeline.StageTransitionProperty
The name of the pipeline in which you want to disable the flow of artifacts from one stage to another.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnPipeline(Construct scope,
java.lang.String id,
CfnPipelineProps props)
Create a new `AWS::CodePipeline::Pipeline`.
|
protected |
CfnPipeline(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnPipeline(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
getArtifactStore()
The S3 bucket where artifacts for the pipeline are stored.
|
java.lang.Object |
getArtifactStores()
A mapping of `artifactStore` objects and their corresponding AWS Regions.
|
java.lang.String |
getAttrVersion()
The version of the pipeline.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.Object |
getDisableInboundStageTransitions()
Represents the input of a `DisableStageTransition` action.
|
java.lang.String |
getName()
The name of the pipeline.
|
java.lang.Object |
getRestartExecutionOnUpdate()
Indicates whether to rerun the CodePipeline pipeline after you update it.
|
java.lang.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` .
|
java.lang.Object |
getStages()
Represents information about a stage and its definition.
|
TagManager |
getTags()
Specifies the tags applied to the pipeline.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setArtifactStore(CfnPipeline.ArtifactStoreProperty value)
The S3 bucket where artifacts for the pipeline are stored.
|
void |
setArtifactStore(IResolvable value)
The S3 bucket where artifacts for the pipeline are stored.
|
void |
setArtifactStores(IResolvable value)
A mapping of `artifactStore` objects and their corresponding AWS Regions.
|
void |
setArtifactStores(java.util.List<java.lang.Object> value)
A mapping of `artifactStore` objects and their corresponding AWS Regions.
|
void |
setDisableInboundStageTransitions(IResolvable value)
Represents the input of a `DisableStageTransition` action.
|
void |
setDisableInboundStageTransitions(java.util.List<java.lang.Object> value)
Represents the input of a `DisableStageTransition` action.
|
void |
setName(java.lang.String value)
The name of the pipeline.
|
void |
setRestartExecutionOnUpdate(java.lang.Boolean value)
Indicates whether to rerun the CodePipeline pipeline after you update it.
|
void |
setRestartExecutionOnUpdate(IResolvable value)
Indicates whether to rerun the CodePipeline pipeline after you update it.
|
void |
setRoleArn(java.lang.String value)
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` .
|
void |
setStages(IResolvable value)
Represents information about a stage and its definition.
|
void |
setStages(java.util.List<java.lang.Object> value)
Represents information about a stage and its definition.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnPipeline(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnPipeline(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnPipeline(Construct scope, java.lang.String id, CfnPipelineProps props)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.props
- - resource properties. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrVersion()
A new pipeline is always assigned a version number of 1. This number increments when a pipeline is updated.
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
public java.lang.String getRoleArn()
public void setRoleArn(java.lang.String value)
public java.lang.Object getStages()
public void setStages(IResolvable value)
public void setStages(java.util.List<java.lang.Object> value)
public java.lang.Object getArtifactStore()
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
.
public void setArtifactStore(IResolvable value)
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
.
public void setArtifactStore(CfnPipeline.ArtifactStoreProperty value)
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
.
public java.lang.Object getArtifactStores()
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
.
public void setArtifactStores(IResolvable value)
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
.
public void setArtifactStores(java.util.List<java.lang.Object> value)
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
.
public java.lang.Object getDisableInboundStageTransitions()
public void setDisableInboundStageTransitions(IResolvable value)
public void setDisableInboundStageTransitions(java.util.List<java.lang.Object> value)
public java.lang.String getName()
public void setName(java.lang.String value)
public java.lang.Object getRestartExecutionOnUpdate()
public void setRestartExecutionOnUpdate(java.lang.Boolean value)
public void setRestartExecutionOnUpdate(IResolvable value)