software.amazon.awscdk.pipelines

Interface BaseStageOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

AddStageOptions

All Known Implementing Classes:

AddStageOptions.Jsii$Proxy, BaseStageOptions.Jsii$Proxy

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

(experimental) Base options for a pipelines stage.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static BaseStageOptions.Builder	builder()
default Boolean	getConfirmBroadeningPermissions() (experimental) Runs a `cdk diff --security-only --fail` to pause the pipeline if there are any security changes.
default ITopic	getSecurityNotificationTopic() (experimental) Optional SNS topic to send notifications to when the security check registers changes within the application.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getConfirmBroadeningPermissions

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

(experimental) Runs a `cdk diff --security-only --fail` to pause the pipeline if there are any security changes.

If the stage is configured with confirmBroadeningPermissions enabled, you can use this property to override the stage configuration. For example, Pipeline Stage "Prod" has confirmBroadeningPermissions enabled, with applications "A", "B", "C". All three applications will run a security check, but if we want to disable the one for "C", we run stage.addApplication(C, { confirmBroadeningPermissions: false }) to override the pipeline stage behavior.

Adds 1 to the run order space.

Default: false

getSecurityNotificationTopic

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

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

Default: undefined no notification topic for security check manual approval action

builder

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

Returns:

a BaseStageOptions.Builder of BaseStageOptions