interface DeployCdkStackActionProps ⚠️

Language	Type name
.NET	Amazon.CDK.Pipelines.DeployCdkStackActionProps
Java	software.amazon.awscdk.pipelines.DeployCdkStackActionProps
Python	aws_cdk.pipelines.DeployCdkStackActionProps
TypeScript (source)	@aws-cdk/pipelines » DeployCdkStackActionProps

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

Properties 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 iam from '@aws-cdk/aws-iam';
import * as pipelines from '@aws-cdk/pipelines';

declare const artifact: codepipeline.Artifact;
declare const role: iam.Role;
const deployCdkStackActionProps: pipelines.DeployCdkStackActionProps = {
  actionRole: role,
  cloudAssemblyInput: artifact,
  stackName: 'stackName',
  templatePath: 'templatePath',

  // the properties below are optional
  baseActionName: 'baseActionName',
  changeSetName: 'changeSetName',
  cloudFormationExecutionRole: role,
  dependencyStackArtifactIds: ['dependencyStackArtifactIds'],
  executeRunOrder: 123,
  output: artifact,
  outputFileName: 'outputFileName',
  prepareRunOrder: 123,
  region: 'region',
  stackArtifactId: 'stackArtifactId',
  templateConfigurationPath: 'templateConfigurationPath',
};

Properties

Name	Type	Description
actionRole⚠️	IRole	Role for the action to assume.
cloudAssemblyInput⚠️	Artifact	The CodePipeline artifact that holds the Cloud Assembly.
stackName⚠️	string	The name of the stack that should be created/updated.
templatePath⚠️	string	Relative path of template in the input artifact.
baseActionName?⚠️	string	Base name of the action.
changeSetName?⚠️	string	Name of the change set to create and deploy.
cloudFormationExecutionRole?⚠️	IRole	Role to execute CloudFormation under.
dependencyStackArtifactIds?⚠️	string[]	Artifact ID for the stacks this stack depends on.
executeRunOrder?⚠️	number	Run order for the Execute action.
output?⚠️	Artifact	Artifact to write Stack Outputs to.
outputFileName?⚠️	string	Filename in output to write Stack outputs to.
prepareRunOrder?⚠️	number	Run order for the Prepare action.
region?⚠️	string	Region to deploy into.
stackArtifactId?⚠️	string	Artifact ID for the stack deployed here.
templateConfigurationPath?⚠️	string	Template configuration path relative to the input artifact.

---

actionRole⚠️

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

Type: IRole

Role for the action to assume.

This controls the account to deploy into

---

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.

---

stackName⚠️

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

Type: string

The name of the stack that should be created/updated.

---

templatePath⚠️

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

Type: string

Relative path of template in the input artifact.

---

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.

---

cloudFormationExecutionRole?⚠️

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

Type: IRole (optional, default: Execute CloudFormation using the action role)

Role to execute CloudFormation under.

---

dependencyStackArtifactIds?⚠️

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

Type: string[] (optional, default: No dependencies)

Artifact ID for the stacks this stack depends on.

Used for pipeline order checking.

---

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.

---

region?⚠️

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

Type: string (optional, default: Same region as pipeline)

Region to deploy into.

---

stackArtifactId?⚠️

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

Type: string (optional, default: Order will not be checked)

Artifact ID for the stack deployed here.

Used for pipeline order checking.

---

templateConfigurationPath?⚠️

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

Type: string (optional, default: No template configuration)

Template configuration path relative to the input artifact.