ManualApprovalStepProps

class aws_cdk.pipelines.ManualApprovalStepProps(*, comment=None, notification_topic=None, review_url=None)

Bases: object

Construction properties for a ManualApprovalStep.

Parameters:

comment (Optional[str]) – The comment to display with this manual approval. Default: - No comment
notification_topic (Optional[ITopic]) – Optional SNS topic to send notifications to when an approval is pending. Default: - No notifications
review_url (Optional[str]) – The URL for review associated with this manual approval. Default: - No URL

ExampleMetadata:

infused

Example:

# pipeline: pipelines.CodePipeline

preprod = MyApplicationStage(self, "PreProd")
prod = MyApplicationStage(self, "Prod")
topic = sns.Topic(self, "ChangeApprovalTopic")

pipeline.add_stage(preprod,
    post=[
        pipelines.ShellStep("Validate Endpoint",
            commands=["curl -Ssf https://my.webservice.com/"]
        )
    ]
)
pipeline.add_stage(prod,
    pre=[pipelines.ManualApprovalStep("PromoteToProd",
        # All options below are optional
        comment="Please validate changes",
        review_url="https://my.webservice.com/",
        notification_topic=topic
    )]
)

Attributes

comment

The comment to display with this manual approval.

Default:

No comment

notification_topic

Optional SNS topic to send notifications to when an approval is pending.

Default:

No notifications

review_url

The URL for review associated with this manual approval.

Default:

No URL