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.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:16.518Z")
 @Stability(value=Stable)
public interface CfnPipelineProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::CodePipeline::Pipeline`.

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnPipelineProps.Builder A builder for CfnPipelineProps
static class	CfnPipelineProps.Jsii$Proxy An implementation for CfnPipelineProps

Method Summary

Modifier and Type	Method and Description
static CfnPipelineProps.Builder	builder()
default Object	getArtifactStore() `AWS::CodePipeline::Pipeline.ArtifactStore`.
default Object	getArtifactStores() `AWS::CodePipeline::Pipeline.ArtifactStores`.
default Object	getDisableInboundStageTransitions() `AWS::CodePipeline::Pipeline.DisableInboundStageTransitions`.
default String	getName() `AWS::CodePipeline::Pipeline.Name`.
default Object	getRestartExecutionOnUpdate() `AWS::CodePipeline::Pipeline.RestartExecutionOnUpdate`.
String	getRoleArn() `AWS::CodePipeline::Pipeline.RoleArn`.
Object	getStages() `AWS::CodePipeline::Pipeline.Stages`.
default List<CfnTag>	getTags() `AWS::CodePipeline::Pipeline.Tags`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getArtifactStore

@Stability(value=Stable)
 @Nullable
default Object getArtifactStore()

`AWS::CodePipeline::Pipeline.ArtifactStore`.

getArtifactStores

@Stability(value=Stable)
 @Nullable
default Object getArtifactStores()

`AWS::CodePipeline::Pipeline.ArtifactStores`.

getDisableInboundStageTransitions

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

`AWS::CodePipeline::Pipeline.DisableInboundStageTransitions`.

getName

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

`AWS::CodePipeline::Pipeline.Name`.

getRestartExecutionOnUpdate

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

`AWS::CodePipeline::Pipeline.RestartExecutionOnUpdate`.

getRoleArn

@Stability(value=Stable)
 @NotNull
String getRoleArn()

`AWS::CodePipeline::Pipeline.RoleArn`.

getStages

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

`AWS::CodePipeline::Pipeline.Stages`.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

`AWS::CodePipeline::Pipeline.Tags`.

builder

@Stability(value=Stable)
static CfnPipelineProps.Builder builder()

Returns:

a CfnPipelineProps.Builder of CfnPipelineProps