software.amazon.awscdk.pipelines

Interface CdkStageProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CdkStageProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.31.0 (build 6fa403d)",
           date="2021-08-11T10:33:08.813Z")
 @Stability(value=Experimental)
public interface CdkStageProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Construction properties for a CdkStage.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CdkStageProps.Builder	builder()
Artifact	getCloudAssemblyArtifact() (experimental) The CodePipeline Artifact with the Cloud Assembly.
default Boolean	getConfirmBroadeningPermissions() (experimental) Run a security check before every application prepare/deploy actions.
IStageHost	getHost() (experimental) Features the Stage needs from its environment.
IStage	getPipelineStage() (experimental) The underlying Pipeline Stage associated with thisCdkStage.
default ITopic	getSecurityNotificationTopic() (experimental) Optional SNS topic to send notifications to when any security check registers changes within a application.
String	getStageName() (experimental) Name of the stage that should be created.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCloudAssemblyArtifact

@Stability(value=Experimental)
 @NotNull
Artifact getCloudAssemblyArtifact()

(experimental) The CodePipeline Artifact with the Cloud Assembly.

getHost

@Stability(value=Experimental)
 @NotNull
IStageHost getHost()

(experimental) Features the Stage needs from its environment.

getPipelineStage

@Stability(value=Experimental)
 @NotNull
IStage getPipelineStage()

(experimental) The underlying Pipeline Stage associated with thisCdkStage.

getStageName

@Stability(value=Experimental)
 @NotNull
String getStageName()

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

getConfirmBroadeningPermissions

@Stability(value=Experimental)
 @Nullable
default Boolean getConfirmBroadeningPermissions()

(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

getSecurityNotificationTopic

@Stability(value=Experimental)
 @Nullable
default ITopic getSecurityNotificationTopic()

(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

builder

@Stability(value=Experimental)
static CdkStageProps.Builder builder()

Returns:

a CdkStageProps.Builder of CdkStageProps