software.amazon.awscdk.services.codepipeline

Class CfnPipeline

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.codepipeline.CfnPipeline

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.72.0 (build 4b8828b)",
           date="2023-01-03T16:22:32.172Z")
 @Stability(value=Stable)
public class CfnPipeline
extends CfnResource
implements IInspectable

A CloudFormation `AWS::CodePipeline::Pipeline`.

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();
 

Nested Class Summary

Nested Classes

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.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnPipeline(Construct scope, 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)

Method Summary

Modifier and Type	Method and Description
Object	getArtifactStore() The S3 bucket where artifacts for the pipeline are stored.
Object	getArtifactStores() A mapping of `artifactStore` objects and their corresponding AWS Regions.
String	getAttrVersion() The version of the pipeline.
protected Map<String,Object>	getCfnProperties()
Object	getDisableInboundStageTransitions() Represents the input of a `DisableStageTransition` action.
String	getName() The name of the pipeline.
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.
TagManager	getTags() Specifies the tags applied to the pipeline.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,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(List<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(List<Object> value) Represents the input of a `DisableStageTransition` action.
void	setName(String value) The name of the pipeline.
void	setRestartExecutionOnUpdate(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(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(List<Object> value) Represents information about a stage and its definition.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnPipeline

protected CfnPipeline(software.amazon.jsii.JsiiObjectRef objRef)

CfnPipeline

protected CfnPipeline(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnPipeline

@Stability(value=Stable)
public CfnPipeline(@NotNull
                                            Construct scope,
                                            @NotNull
                                            String id,
                                            @NotNull
                                            CfnPipelineProps props)

Create a new `AWS::CodePipeline::Pipeline`.

Parameters:

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.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrVersion

@Stability(value=Stable)
 @NotNull
public String getAttrVersion()

The version of the pipeline.

A new pipeline is always assigned a version number of 1. This number increments when a pipeline is updated.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

Specifies the tags applied to the pipeline.

getRoleArn

@Stability(value=Stable)
 @NotNull
public 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` .

setRoleArn

@Stability(value=Stable)
public void setRoleArn(@NotNull
                                                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` .

getStages

@Stability(value=Stable)
 @NotNull
public Object getStages()

Represents information about a stage and its definition.

setStages

@Stability(value=Stable)
public void setStages(@NotNull
                                               IResolvable value)

Represents information about a stage and its definition.

setStages

@Stability(value=Stable)
public void setStages(@NotNull
                                               List<Object> value)

Represents information about a stage and its definition.

getArtifactStore

@Stability(value=Stable)
 @Nullable
public 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 .

setArtifactStore

@Stability(value=Stable)
public void setArtifactStore(@Nullable
                                                      IResolvable value)

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 .

setArtifactStore

@Stability(value=Stable)
public void setArtifactStore(@Nullable
                                                      CfnPipeline.ArtifactStoreProperty value)

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 .

getArtifactStores

@Stability(value=Stable)
 @Nullable
public 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 .

setArtifactStores

@Stability(value=Stable)
public void setArtifactStores(@Nullable
                                                       IResolvable value)

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 .

setArtifactStores

@Stability(value=Stable)
public void setArtifactStores(@Nullable
                                                       List<Object> value)

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 .

getDisableInboundStageTransitions

@Stability(value=Stable)
 @Nullable
public Object getDisableInboundStageTransitions()

Represents the input of a `DisableStageTransition` action.

setDisableInboundStageTransitions

@Stability(value=Stable)
public void setDisableInboundStageTransitions(@Nullable
                                                                       IResolvable value)

Represents the input of a `DisableStageTransition` action.

setDisableInboundStageTransitions

@Stability(value=Stable)
public void setDisableInboundStageTransitions(@Nullable
                                                                       List<Object> value)

Represents the input of a `DisableStageTransition` action.

getName

@Stability(value=Stable)
 @Nullable
public String getName()

The name of the pipeline.

setName

@Stability(value=Stable)
public void setName(@Nullable
                                             String value)

The name of the pipeline.

getRestartExecutionOnUpdate

@Stability(value=Stable)
 @Nullable
public Object getRestartExecutionOnUpdate()

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

setRestartExecutionOnUpdate

@Stability(value=Stable)
public void setRestartExecutionOnUpdate(@Nullable
                                                                 Boolean value)

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

setRestartExecutionOnUpdate

@Stability(value=Stable)
public void setRestartExecutionOnUpdate(@Nullable
                                                                 IResolvable value)

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