1.204.0

interface CdkStageProps ⚠️

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

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

Construction properties for a CdkStage.

Example

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

declare const artifact: codepipeline.Artifact;
declare const stage: codepipeline.IStage;
declare const stageHost: pipelines.IStageHost;
declare const topic: sns.Topic;
const cdkStageProps: pipelines.CdkStageProps = {
  cloudAssemblyArtifact: artifact,
  host: stageHost,
  pipelineStage: stage,
  stageName: 'stageName',

  // the properties below are optional
  confirmBroadeningPermissions: false,
  securityNotificationTopic: topic,
};

Properties

NameTypeDescription
cloudAssemblyArtifact⚠️ArtifactThe CodePipeline Artifact with the Cloud Assembly.
host⚠️IStageHostFeatures the Stage needs from its environment.
pipelineStage⚠️IStageThe underlying Pipeline Stage associated with thisCdkStage.
stageName⚠️stringName of the stage that should be created.
confirmBroadeningPermissions?⚠️booleanRun a security check before every application prepare/deploy actions.
securityNotificationTopic?⚠️ITopicOptional SNS topic to send notifications to when any security check registers changes within a application.

cloudAssemblyArtifact⚠️

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

Type: Artifact

The CodePipeline Artifact with the Cloud Assembly.

host⚠️

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

Type: IStageHost

Features the Stage needs from its environment.

pipelineStage⚠️

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

Type: IStage

The underlying Pipeline Stage associated with thisCdkStage.

stageName⚠️

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

Type: string

Name of the stage that should be created.

confirmBroadeningPermissions?⚠️

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

Type: boolean (optional, default: false)

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 })

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 stage level notification topic)

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 })

← PreviousNext →