Package 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:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:37.905Z") @Stability(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();

  • 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 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 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.

    • 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()
      Specifies the tags applied to the pipeline.

    • 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.

      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(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(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(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(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(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(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.