AWS CDK Reference

Appearance

v2.275.0

StackDeploymentProps Struct ​

Properties for a StackDeployment.

Source
pipelines/lib/blueprint/stack-deployment.ts

Example ​

ts
// 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',
    displayName: 'displayName',
  }],
  assumeRoleArn: 'assumeRoleArn',
  executionRoleArn: 'executionRoleArn',
  region: 'region',
  tags: {
    tagsKey: 'tags',
  },
  templateS3Uri: 'templateS3Uri',
};

Properties ​

absoluteTemplatePathstringabsolute_template_pathstrabsoluteTemplatePathStringAbsoluteTemplatePathstringAbsoluteTemplatePath*stringrequired#
Template path on disk to cloud assembly (cdk.out).
accountoptionalstringaccountoptionalstraccountoptionalStringAccountoptionalstringAccountoptional*string#
Account where the stack should be deployed.

Default: Pipeline account

assetsoptionalStackAsset[]assetsoptionaltyping.List[StackAsset]assetsoptionalList<StackAsset>AssetsoptionalStackAsset[]Assetsoptional*[]StackAsset#
Assets referenced by this stack.

Default: No assets

assumeRoleArnoptionalstringassume_role_arnoptionalstrassumeRoleArnoptionalStringAssumeRoleArnoptionalstringAssumeRoleArnoptional*string#
Role to assume before deploying this stack.

Default: Don't assume any role

constructPathstringconstruct_pathstrconstructPathStringConstructPathstringConstructPath*stringrequired#
Construct path for this stack.
executionRoleArnoptionalstringexecution_role_arnoptionalstrexecutionRoleArnoptionalStringExecutionRoleArnoptionalstringExecutionRoleArnoptional*string#
Execution role to pass to CloudFormation.

Default: No execution role

regionoptionalstringregionoptionalstrregionoptionalStringRegionoptionalstringRegionoptional*string#
Region where the stack should be deployed.

Default: Pipeline region

stackArtifactIdstringstack_artifact_idstrstackArtifactIdStringStackArtifactIdstringStackArtifactId*stringrequired#
Artifact ID for this stack.
stackNamestringstack_namestrstackNameStringStackNamestringStackName*stringrequired#
Name for this stack.
tagsoptional{ [key: string]: string }tagsoptionaltyping.Mapping[str, str]tagsoptionalMap<String, String>TagsoptionalIDictionary<string, string>Tagsoptional*map[string]*string#
Tags to apply to the stack.

Default: No tags

templateS3Urioptionalstringtemplate_s3_urioptionalstrtemplateS3UrioptionalStringTemplateS3UrioptionalstringTemplateS3Urioptional*string#
The S3 URL which points to the template asset location in the publishing bucket.

Default: Stack template is not published