interface StackDeploymentProps

Language	Type name
.NET	Amazon.CDK.Pipelines.StackDeploymentProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/pipelines#StackDeploymentProps
Java	software.amazon.awscdk.pipelines.StackDeploymentProps
Python	aws_cdk.pipelines.StackDeploymentProps
TypeScript (source)	aws-cdk-lib » pipelines » StackDeploymentProps

Properties for a StackDeployment.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { pipelines } from 'aws-cdk-lib';
const stackDeploymentProps: pipelines.StackDeploymentProps = {
  absoluteTemplatePath: 'absoluteTemplatePath',
  constructPath: 'constructPath',
  stackArtifactId: 'stackArtifactId',
  stackName: 'stackName',

  // the properties below are optional
  account: 'account',
  assets: [{
    assetId: 'assetId',
    assetManifestPath: 'assetManifestPath',
    assetSelector: 'assetSelector',
    assetType: pipelines.AssetType.FILE,
    isTemplate: false,

    // the properties below are optional
    assetPublishingRoleArn: 'assetPublishingRoleArn',
  }],
  assumeRoleArn: 'assumeRoleArn',
  executionRoleArn: 'executionRoleArn',
  region: 'region',
  tags: {
    tagsKey: 'tags',
  },
  templateS3Uri: 'templateS3Uri',
};

Properties

Name	Type	Description
absoluteTemplatePath	string	Template path on disk to cloud assembly (cdk.out).
constructPath	string	Construct path for this stack.
stackArtifactId	string	Artifact ID for this stack.
stackName	string	Name for this stack.
account?	string	Account where the stack should be deployed.
assets?	StackAsset[]	Assets referenced by this stack.
assumeRoleArn?	string	Role to assume before deploying this stack.
executionRoleArn?	string	Execution role to pass to CloudFormation.
region?	string	Region where the stack should be deployed.
tags?	{ [string]: string }	Tags to apply to the stack.
templateS3Uri?	string	The S3 URL which points to the template asset location in the publishing bucket.

---

absoluteTemplatePath

Type: string

Template path on disk to cloud assembly (cdk.out).

---

constructPath

Type: string

Construct path for this stack.

---

stackArtifactId

Type: string

Artifact ID for this stack.

---

stackName

Type: string

Name for this stack.

---

account?

Type: string (optional, default: Pipeline account)

Account where the stack should be deployed.

---

assets?

Type: StackAsset[] (optional, default: No assets)

Assets referenced by this stack.

---

assumeRoleArn?

Type: string (optional, default: Don't assume any role)

Role to assume before deploying this stack.

---

executionRoleArn?

Type: string (optional, default: No execution role)

Execution role to pass to CloudFormation.

---

region?

Type: string (optional, default: Pipeline region)

Region where the stack should be deployed.

---

tags?

Type: { [string]: string } (optional, default: No tags)

Tags to apply to the stack.

---

templateS3Uri?

Type: string (optional, default: Stack template is not published)

The S3 URL which points to the template asset location in the publishing bucket.