1.204.0

interface AddStageOptions ⚠️

LanguageType name
.NETAmazon.CDK.Pipelines.AddStageOptions
Javasoftware.amazon.awscdk.pipelines.AddStageOptions
Pythonaws_cdk.pipelines.AddStageOptions
TypeScript (source)@aws-cdk/pipelines » AddStageOptions

⚠️ Deprecated: This class is part of the old API. Use the API based on the CodePipeline class instead

Options for adding an application stage to a pipeline.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as sns from '@aws-cdk/aws-sns';
import * as pipelines from '@aws-cdk/pipelines';

declare const topic: sns.Topic;
const addStageOptions: pipelines.AddStageOptions = {
  confirmBroadeningPermissions: false,
  extraRunOrderSpace: 123,
  manualApprovals: false,
  securityNotificationTopic: topic,
};

Properties

NameTypeDescription
confirmBroadeningPermissions?⚠️booleanRuns a cdk diff --security-only --fail to pause the pipeline if there are any security changes.
extraRunOrderSpace?⚠️numberAdd room for extra actions.
manualApprovals?⚠️booleanAdd manual approvals before executing change sets.
securityNotificationTopic?⚠️ITopicOptional SNS topic to send notifications to when the security check registers changes within the application.

confirmBroadeningPermissions?⚠️

⚠️ Deprecated: This class is part of the old API. Use the API based on the CodePipeline class instead

Type: boolean (optional, default: false)

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.

extraRunOrderSpace?⚠️

⚠️ Deprecated: This class is part of the old API. Use the API based on the CodePipeline class instead

Type: number (optional, default: 0)

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.

manualApprovals?⚠️

⚠️ Deprecated: This class is part of the old API. Use the API based on the CodePipeline class instead

Type: boolean (optional, default: false)

Add manual approvals before executing change sets.

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

securityNotificationTopic?⚠️

⚠️ Deprecated: This class is part of the old API. Use the API based on the CodePipeline class instead

Type: ITopic (optional, default: undefined no notification topic for security check manual approval action)

Optional SNS topic to send notifications to when the security check registers changes within the application.

← PreviousNext →