software.amazon.awscdk.pipelines

Class BaseStageOptions.Builder

java.lang.Object

software.amazon.awscdk.pipelines.BaseStageOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<BaseStageOptions>

Enclosing interface:

BaseStageOptions

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

A builder for BaseStageOptions

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
BaseStageOptions	build() Builds the configured instance.
BaseStageOptions.Builder	confirmBroadeningPermissions(Boolean confirmBroadeningPermissions) Sets the value of BaseStageOptions.getConfirmBroadeningPermissions()
BaseStageOptions.Builder	securityNotificationTopic(ITopic securityNotificationTopic) Sets the value of BaseStageOptions.getSecurityNotificationTopic()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

confirmBroadeningPermissions

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

Sets the value of BaseStageOptions.getConfirmBroadeningPermissions()

Parameters:

confirmBroadeningPermissions - 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.

Returns:

this

securityNotificationTopic

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

Sets the value of BaseStageOptions.getSecurityNotificationTopic()

Parameters:

securityNotificationTopic - Optional SNS topic to send notifications to when the security check registers changes within the application.

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of BaseStageOptions

Throws:

NullPointerException - if any required attribute was not provided