Package software.amazon.awscdk.services.codepipeline

Interface CfnPipelineProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnPipelineProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:37.921Z") @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();

  • Method Details

    • getRoleArn

      @Stability(Stable) @NotNull 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 .

    • getStages

      @Stability(Stable) @NotNull Object getStages()
      Represents information about a stage and its definition.

    • getArtifactStore

      @Stability(Stable) @Nullable default 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 .

    • getArtifactStores

      @Stability(Stable) @Nullable default 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 .

    • getDisableInboundStageTransitions

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

    • getName

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

    • getRestartExecutionOnUpdate

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

    • getTags

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

    • builder

      @Stability(Stable) static CfnPipelineProps.Builder builder()
      Returns:
      a CfnPipelineProps.Builder of CfnPipelineProps