BaseStageOptions

class aws_cdk.pipelines.BaseStageOptions(*, confirm_broadening_permissions=None, security_notification_topic=None)

Bases: object

(deprecated) Base options for a pipelines stage.

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

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

base_stage_options = pipelines.BaseStageOptions(
    confirm_broadening_permissions=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

Return type

Optional[bool]

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

Return type

Optional[ITopic]