Package software.amazon.awscdk.services.codepipeline

Class CfnPipeline

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.codepipeline.CfnPipeline
All Implemented Interfaces:
IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.89.0 (build 2f74b3e)", date="2023-10-26T00:56:05.662Z") @Stability(Stable) public class CfnPipeline extends CfnResource implements IInspectable, ITaggable
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();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnPipeline

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

    • CfnPipeline

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

    • CfnPipeline

      @Stability(Stable) public CfnPipeline(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnPipelineProps props)
      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.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(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(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()

    • getAttrVersion

      @Stability(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(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getRoleArn

      @Stability(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(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(Stable) @NotNull public Object getStages()
      Represents information about a stage and its definition.

    • setStages

      @Stability(Stable) public void setStages(@NotNull IResolvable value)
      Represents information about a stage and its definition.

    • setStages

      @Stability(Stable) public void setStages(@NotNull List<Object> value)
      Represents information about a stage and its definition.

    • getArtifactStore

      @Stability(Stable) @Nullable public Object getArtifactStore()
      The S3 bucket where artifacts for the pipeline are stored.

    • setArtifactStore

      @Stability(Stable) public void setArtifactStore(@Nullable IResolvable value)
      The S3 bucket where artifacts for the pipeline are stored.

    • setArtifactStore

      @Stability(Stable) public void setArtifactStore(@Nullable CfnPipeline.ArtifactStoreProperty value)
      The S3 bucket where artifacts for the pipeline are stored.

    • getArtifactStores

      @Stability(Stable) @Nullable public Object getArtifactStores()
      A mapping of artifactStore objects and their corresponding AWS Regions.

    • setArtifactStores

      @Stability(Stable) public void setArtifactStores(@Nullable IResolvable value)
      A mapping of artifactStore objects and their corresponding AWS Regions.

    • setArtifactStores

      @Stability(Stable) public void setArtifactStores(@Nullable List<Object> value)
      A mapping of artifactStore objects and their corresponding AWS Regions.

    • getDisableInboundStageTransitions

      @Stability(Stable) @Nullable public Object getDisableInboundStageTransitions()
      Represents the input of a DisableStageTransition action.

    • setDisableInboundStageTransitions

      @Stability(Stable) public void setDisableInboundStageTransitions(@Nullable IResolvable value)
      Represents the input of a DisableStageTransition action.

    • setDisableInboundStageTransitions

      @Stability(Stable) public void setDisableInboundStageTransitions(@Nullable List<Object> value)
      Represents the input of a DisableStageTransition action.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name of the pipeline.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of the pipeline.

    • getRestartExecutionOnUpdate

      @Stability(Stable) @Nullable public Object getRestartExecutionOnUpdate()
      Indicates whether to rerun the CodePipeline pipeline after you update it.

    • setRestartExecutionOnUpdate

      @Stability(Stable) public void setRestartExecutionOnUpdate(@Nullable Boolean value)
      Indicates whether to rerun the CodePipeline pipeline after you update it.

    • setRestartExecutionOnUpdate

      @Stability(Stable) public void setRestartExecutionOnUpdate(@Nullable IResolvable value)
      Indicates whether to rerun the CodePipeline pipeline after you update it.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      Specifies the tags applied to the pipeline.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      Specifies the tags applied to the pipeline.