AddStageOptions

class aws_cdk.pipelines.AddStageOptions(*, confirm_broadening_permissions=None, security_notification_topic=None, extra_run_order_space=None, manual_approvals=None)

Bases: BaseStageOptions

(deprecated) Options for adding an application stage to a pipeline.

Parameters:

confirm_broadening_permissions (Optional[bool]) – (deprecated) 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
security_notification_topic (Optional[ITopic]) – (deprecated) 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
extra_run_order_space (Union[int, float, None]) – (deprecated) 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. Default: 0
manual_approvals (Optional[bool]) – (deprecated) Add manual approvals before executing change sets. This gives humans the opportunity to confirm the change set looks alright before deploying it. Default: false

Deprecated:

This class is part of the old API. Use the API based on the CodePipeline class instead

Stability:

deprecated

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_sns as sns
import aws_cdk.pipelines as pipelines

# topic: sns.Topic

add_stage_options = pipelines.AddStageOptions(
    confirm_broadening_permissions=False,
    extra_run_order_space=123,
    manual_approvals=False,
    security_notification_topic=topic
)

Attributes

confirm_broadening_permissions

(deprecated) 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
Stability:: deprecated

extra_run_order_space

(deprecated) 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.

Default:: 0
Stability:: deprecated

manual_approvals

(deprecated) Add manual approvals before executing change sets.

This gives humans the opportunity to confirm the change set looks alright before deploying it.

Default:: false
Stability:: deprecated

security_notification_topic

(deprecated) 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
Stability:: deprecated