CdkStage

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

Bases: Construct

(deprecated) Stage in a CdkPipeline.

You don’t need to instantiate this class directly. Use cdkPipeline.addStage() instead.

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 = pipelines.CdkStage(self, "MyCdkStage",
    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
)
Parameters
  • scope (Construct) –

  • id (str) –

  • 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

Stability

deprecated

Methods

add_actions(*actions)

(deprecated) Add one or more CodePipeline Actions.

You need to make sure it is created with the right runOrder. Call nextSequentialRunOrder() for every action to get actions to execute in sequence.

Parameters

actions (IAction) –

Stability

deprecated

Return type

None

add_application(app_stage, *, extra_run_order_space=None, manual_approvals=None, confirm_broadening_permissions=None, security_notification_topic=None)

(deprecated) Add all stacks in the application Stage to this stage.

The application construct should subclass Stage and can contain any number of Stacks inside it that may have dependency relationships on one another.

All stacks in the application will be deployed in the appropriate order, and all assets found in the application will be added to the asset publishing stage.

Parameters
  • app_stage (Stage) –

  • 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

  • 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

Stability

deprecated

Return type

None

add_manual_approval_action(*, action_name=None, run_order=None)

(deprecated) Add a manual approval action.

If you need more flexibility than what this method offers, use addAction with a ManualApprovalAction.

Parameters
  • action_name (Optional[str]) – (deprecated) The name of the manual approval action. Default: ‘ManualApproval’ with a rolling counter

  • run_order (Union[int, float, None]) – (deprecated) The runOrder for this action. Default: - The next sequential runOrder

Stability

deprecated

Return type

None

add_stack_artifact_deployment(stack_artifact, *, execute_run_order=None, run_order=None)

(deprecated) Add a deployment action based on a stack artifact.

Parameters
  • stack_artifact (CloudFormationStackArtifact) –

  • execute_run_order (Union[int, float, None]) – (deprecated) Base runorder. Default: - runOrder + 1

  • run_order (Union[int, float, None]) – (deprecated) Base runorder. Default: - Next sequential runorder

Stability

deprecated

Return type

None

deploys_stack(artifact_id)

(deprecated) Whether this Stage contains an action to deploy the given stack, identified by its artifact ID.

Parameters

artifact_id (str) –

Stability

deprecated

Return type

bool

next_sequential_run_order(count=None)

(deprecated) Return the runOrder number necessary to run the next Action in sequence with the rest.

FIXME: This is here because Actions are immutable and can’t be reordered after creation, nor is there a way to specify relative priorities, which is a limitation that we should take away in the base library.

Parameters

count (Union[int, float, None]) –

Stability

deprecated

Return type

Union[int, float]

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

node

The construct tree node associated with this construct.

Return type

ConstructNode

Static Methods

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool