CdkStageProps

class aws_cdk.pipelines.CdkStageProps(*, cloud_assembly_artifact, host, pipeline_stage, stage_name, confirm_broadening_permissions=None, security_notification_topic=None)

Bases: object

(deprecated) Construction properties for a CdkStage.

Parameters
  • cloud_assembly_artifact (Artifact) – (deprecated) The CodePipeline Artifact with the Cloud Assembly.

  • host (IStageHost) – (deprecated) Features the Stage needs from its environment.

  • pipeline_stage (IStage) – (deprecated) The underlying Pipeline Stage associated with thisCdkStage.

  • stage_name (str) – (deprecated) Name of the stage that should be created.

  • confirm_broadening_permissions (Optional[bool]) – (deprecated) Run a security check before every application prepare/deploy actions. Note: Stage level security check can be overriden per application as follows: stage.addApplication(app, { confirmBroadeningPermissions: false }) Default: false

  • security_notification_topic (Optional[ITopic]) – (deprecated) Optional SNS topic to send notifications to when any security check registers changes within a application. Note: The Stage Notification Topic can be overriden per application as follows: stage.addApplication(app, { securityNotificationTopic: newTopic }) Default: undefined no stage level notification topic

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_codepipeline as codepipeline
import aws_cdk.aws_sns as sns
import aws_cdk.pipelines as pipelines

# artifact: codepipeline.Artifact
# stage: codepipeline.IStage
# stage_host: pipelines.IStageHost
# topic: sns.Topic

cdk_stage_props = pipelines.CdkStageProps(
    cloud_assembly_artifact=artifact,
    host=stage_host,
    pipeline_stage=stage,
    stage_name="stageName",

    # the properties below are optional
    confirm_broadening_permissions=False,
    security_notification_topic=topic
)

Attributes

cloud_assembly_artifact

(deprecated) The CodePipeline Artifact with the Cloud Assembly.

Stability

deprecated

Return type

Artifact

confirm_broadening_permissions

(deprecated) Run a security check before every application prepare/deploy actions.

Note: Stage level security check can be overriden per application as follows: stage.addApplication(app, { confirmBroadeningPermissions: false })

Default

false

Stability

deprecated

Return type

Optional[bool]

host

(deprecated) Features the Stage needs from its environment.

Stability

deprecated

Return type

IStageHost

pipeline_stage

(deprecated) The underlying Pipeline Stage associated with thisCdkStage.

Stability

deprecated

Return type

IStage

security_notification_topic

(deprecated) Optional SNS topic to send notifications to when any security check registers changes within a application.

Note: The Stage Notification Topic can be overriden per application as follows: stage.addApplication(app, { securityNotificationTopic: newTopic })

Default

undefined no stage level notification topic

Stability

deprecated

Return type

Optional[ITopic]

stage_name

(deprecated) Name of the stage that should be created.

Stability

deprecated

Return type

str