software.amazon.awscdk.pipelines

Class AddStageOptions.Builder

java.lang.Object

software.amazon.awscdk.pipelines.AddStageOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<AddStageOptions>

Enclosing interface:

AddStageOptions

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

A builder for AddStageOptions

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
AddStageOptions	build() Builds the configured instance.
AddStageOptions.Builder	confirmBroadeningPermissions(Boolean confirmBroadeningPermissions) Sets the value of BaseStageOptions.getConfirmBroadeningPermissions()
AddStageOptions.Builder	extraRunOrderSpace(Number extraRunOrderSpace) Sets the value of AddStageOptions.getExtraRunOrderSpace()
AddStageOptions.Builder	manualApprovals(Boolean manualApprovals) Sets the value of AddStageOptions.getManualApprovals()
AddStageOptions.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

extraRunOrderSpace

@Stability(value=Experimental)
public AddStageOptions.Builder extraRunOrderSpace(Number extraRunOrderSpace)

Sets the value of AddStageOptions.getExtraRunOrderSpace()

Parameters:

extraRunOrderSpace - Add room for extra actions. You can use this to make extra room in the runOrder sequence between the changeset 'prepare' and 'execute' actions and insert your own actions there.

Returns:

this

manualApprovals

@Stability(value=Experimental)
public AddStageOptions.Builder manualApprovals(Boolean manualApprovals)

Sets the value of AddStageOptions.getManualApprovals()

Parameters:

manualApprovals - Add manual approvals before executing change sets. This gives humans the opportunity to confirm the change set looks alright before deploying it.

Returns:

this

confirmBroadeningPermissions

@Stability(value=Experimental)
public AddStageOptions.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 AddStageOptions.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 AddStageOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of AddStageOptions

Throws:

NullPointerException - if any required attribute was not provided