1.204.0

interface DeployCdkStackActionOptions ⚠️

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

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

Customization options for a DeployCdkStackAction.

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 pipelines from '@aws-cdk/pipelines';

declare const artifact: codepipeline.Artifact;
const deployCdkStackActionOptions: pipelines.DeployCdkStackActionOptions = {
  cloudAssemblyInput: artifact,

  // the properties below are optional
  baseActionName: 'baseActionName',
  changeSetName: 'changeSetName',
  executeRunOrder: 123,
  output: artifact,
  outputFileName: 'outputFileName',
  prepareRunOrder: 123,
};

Properties

NameTypeDescription
cloudAssemblyInput⚠️ArtifactThe CodePipeline artifact that holds the Cloud Assembly.
baseActionName?⚠️stringBase name of the action.
changeSetName?⚠️stringName of the change set to create and deploy.
executeRunOrder?⚠️numberRun order for the Execute action.
output?⚠️ArtifactArtifact to write Stack Outputs to.
outputFileName?⚠️stringFilename in output to write Stack outputs to.
prepareRunOrder?⚠️numberRun order for the Prepare action.

cloudAssemblyInput⚠️

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

Type: Artifact

The CodePipeline artifact that holds the Cloud Assembly.

baseActionName?⚠️

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

Type: string (optional, default: stackName)

Base name of the action.

changeSetName?⚠️

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

Type: string (optional, default: 'PipelineChange')

Name of the change set to create and deploy.

executeRunOrder?⚠️

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

Type: number (optional, default: prepareRunOrder + 1)

Run order for the Execute action.

output?⚠️

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

Type: Artifact (optional, default: No outputs)

Artifact to write Stack Outputs to.

outputFileName?⚠️

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

Type: string (optional, default: Required when 'output' is set)

Filename in output to write Stack outputs to.

prepareRunOrder?⚠️

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

Type: number (optional, default: 1)

Run order for the Prepare action.

← PreviousNext →