software.amazon.awscdk.pipelines

Class CdkStage.Builder

java.lang.Object

software.amazon.awscdk.pipelines.CdkStage.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CdkStage>

Enclosing class:

CdkStage

@Stability(value=Experimental)
public static final class CdkStage.Builder
extends Object
implements software.amazon.jsii.Builder<CdkStage>

(experimental) A fluent builder for CdkStage.

Method Summary

Modifier and Type	Method and Description
CdkStage	build()
CdkStage.Builder	cloudAssemblyArtifact(Artifact cloudAssemblyArtifact) (experimental) The CodePipeline Artifact with the Cloud Assembly.
CdkStage.Builder	confirmBroadeningPermissions(Boolean confirmBroadeningPermissions) (experimental) Run a security check before every application prepare/deploy actions.
static CdkStage.Builder	create(software.constructs.Construct scope, String id)
CdkStage.Builder	host(IStageHost host) (experimental) Features the Stage needs from its environment.
CdkStage.Builder	pipelineStage(IStage pipelineStage) (experimental) The underlying Pipeline Stage associated with thisCdkStage.
CdkStage.Builder	securityNotificationTopic(ITopic securityNotificationTopic) (experimental) Optional SNS topic to send notifications to when any security check registers changes within a application.
CdkStage.Builder	stageName(String stageName) (experimental) Name of the stage that should be created.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static CdkStage.Builder create(software.constructs.Construct scope,
                                                                     String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of CdkStage.Builder.

cloudAssemblyArtifact

@Stability(value=Experimental)
public CdkStage.Builder cloudAssemblyArtifact(Artifact cloudAssemblyArtifact)

(experimental) The CodePipeline Artifact with the Cloud Assembly.

Parameters:

cloudAssemblyArtifact - The CodePipeline Artifact with the Cloud Assembly. This parameter is required.

Returns:

this

host

@Stability(value=Experimental)
public CdkStage.Builder host(IStageHost host)

(experimental) Features the Stage needs from its environment.

Parameters:

host - Features the Stage needs from its environment. This parameter is required.

Returns:

this

pipelineStage

@Stability(value=Experimental)
public CdkStage.Builder pipelineStage(IStage pipelineStage)

(experimental) The underlying Pipeline Stage associated with thisCdkStage.

Parameters:

pipelineStage - The underlying Pipeline Stage associated with thisCdkStage. This parameter is required.

Returns:

this

stageName

@Stability(value=Experimental)
public CdkStage.Builder stageName(String stageName)

(experimental) Name of the stage that should be created.

Parameters:

stageName - Name of the stage that should be created. This parameter is required.

Returns:

this

confirmBroadeningPermissions

@Stability(value=Experimental)
public CdkStage.Builder confirmBroadeningPermissions(Boolean confirmBroadeningPermissions)

(experimental) Run a security check before every application prepare/deploy actions.

Note: Stage level security check can be overriden per application as follows: stage.addApplication(app, { confirmBroadeningPermissions: false })

Default: false

Parameters:

confirmBroadeningPermissions - Run a security check before every application prepare/deploy actions. This parameter is required.

Returns:

this

securityNotificationTopic

@Stability(value=Experimental)
public CdkStage.Builder securityNotificationTopic(ITopic securityNotificationTopic)

(experimental) Optional SNS topic to send notifications to when any security check registers changes within a application.

Note: The Stage Notification Topic can be overriden per application as follows: stage.addApplication(app, { securityNotificationTopic: newTopic })

Default: undefined no stage level notification topic

Parameters:

securityNotificationTopic - Optional SNS topic to send notifications to when any security check registers changes within a application. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public CdkStage build()

Specified by:

build in interface software.amazon.jsii.Builder<CdkStage>