2.184.1

interface AwsCloudFormationStackProperties

LanguageType name
.NETAmazon.CDK.cloud_assembly_schema.AwsCloudFormationStackProperties
Gogithub.com/aws/aws-cdk-go/awscdk/v2/cloudassemblyschema#AwsCloudFormationStackProperties
Javasoftware.amazon.awscdk.cloud_assembly_schema.AwsCloudFormationStackProperties
Pythonaws_cdk.cloud_assembly_schema.AwsCloudFormationStackProperties
TypeScript (source)aws-cdk-lib » cloud_assembly_schema » AwsCloudFormationStackProperties

Artifact properties for CloudFormation stacks.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { cloud_assembly_schema } from 'aws-cdk-lib';

declare const assumeRoleAdditionalOptions: any;
const awsCloudFormationStackProperties: cloud_assembly_schema.AwsCloudFormationStackProperties = {
  templateFile: 'templateFile',

  // the properties below are optional
  assumeRoleAdditionalOptions: {
    assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,
  },
  assumeRoleArn: 'assumeRoleArn',
  assumeRoleExternalId: 'assumeRoleExternalId',
  bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',
  cloudFormationExecutionRoleArn: 'cloudFormationExecutionRoleArn',
  lookupRole: {
    arn: 'arn',

    // the properties below are optional
    assumeRoleAdditionalOptions: {
      assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,
    },
    assumeRoleExternalId: 'assumeRoleExternalId',
    bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',
    requiresBootstrapStackVersion: 123,
  },
  notificationArns: ['notificationArns'],
  parameters: {
    parametersKey: 'parameters',
  },
  requiresBootstrapStackVersion: 123,
  stackName: 'stackName',
  stackTemplateAssetObjectUrl: 'stackTemplateAssetObjectUrl',
  tags: {
    tagsKey: 'tags',
  },
  terminationProtection: false,
  validateOnSynth: false,
};

Properties

NameTypeDescription
templateFilestringA file relative to the assembly root which contains the CloudFormation template for this stack.
assumeRoleAdditionalOptions?{ [string]: any }Additional options to pass to STS when assuming the role.
assumeRoleArn?stringThe role that needs to be assumed to deploy the stack.
assumeRoleExternalId?stringExternal ID to use when assuming role for cloudformation deployments.
bootstrapStackVersionSsmParameter?stringSSM parameter where the bootstrap stack version number can be found.
cloudFormationExecutionRoleArn?stringThe role that is passed to CloudFormation to execute the change set.
lookupRole?BootstrapRoleThe role to use to look up values from the target AWS account.
notificationArns?string[]SNS Notification ARNs that should receive CloudFormation Stack Events.
parameters?{ [string]: string }Values for CloudFormation stack parameters that should be passed when the stack is deployed.
requiresBootstrapStackVersion?numberVersion of bootstrap stack required to deploy this stack.
stackName?stringThe name to use for the CloudFormation stack.
stackTemplateAssetObjectUrl?stringIf the stack template has already been included in the asset manifest, its asset URL.
tags?{ [string]: string }Values for CloudFormation stack tags that should be passed when the stack is deployed.
terminationProtection?booleanWhether to enable termination protection for this stack.
validateOnSynth?booleanWhether this stack should be validated by the CLI after synthesis.

templateFile

Type: string

A file relative to the assembly root which contains the CloudFormation template for this stack.

assumeRoleAdditionalOptions?

Type: { [string]: any } (optional, default: No additional options.)

Additional options to pass to STS when assuming the role.

  • RoleArn should not be used. Use the dedicated assumeRoleArn property instead.
  • ExternalId should not be used. Use the dedicated assumeRoleExternalId instead.

See also: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/STS.html#assumeRole-property

assumeRoleArn?

Type: string (optional, default: No role is assumed (current credentials are used))

The role that needs to be assumed to deploy the stack.

assumeRoleExternalId?

Type: string (optional, default: No external ID)

External ID to use when assuming role for cloudformation deployments.

bootstrapStackVersionSsmParameter?

Type: string (optional, default: Bootstrap stack version number looked up)

SSM parameter where the bootstrap stack version number can be found.

Only used if requiresBootstrapStackVersion is set.

  • If this value is not set, the bootstrap stack name must be known at deployment time so the stack version can be looked up from the stack outputs.
  • If this value is set, the bootstrap stack can have any name because we won't need to look it up.

cloudFormationExecutionRoleArn?

Type: string (optional, default: No role is passed (currently assumed role/credentials are used))

The role that is passed to CloudFormation to execute the change set.

lookupRole?

Type: BootstrapRole (optional, default: No role is assumed (current credentials are used))

The role to use to look up values from the target AWS account.

notificationArns?

Type: string[] (optional, default: No notification arns)

SNS Notification ARNs that should receive CloudFormation Stack Events.

parameters?

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

Values for CloudFormation stack parameters that should be passed when the stack is deployed.

requiresBootstrapStackVersion?

Type: number (optional, default: No bootstrap stack required)

Version of bootstrap stack required to deploy this stack.

stackName?

Type: string (optional, default: name derived from artifact ID)

The name to use for the CloudFormation stack.

stackTemplateAssetObjectUrl?

Type: string (optional, default: Not uploaded yet, upload just before deploying)

If the stack template has already been included in the asset manifest, its asset URL.

tags?

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

Values for CloudFormation stack tags that should be passed when the stack is deployed.

terminationProtection?

Type: boolean (optional, default: false)

Whether to enable termination protection for this stack.

validateOnSynth?

Type: boolean (optional, default: false)

Whether this stack should be validated by the CLI after synthesis.

← PreviousNext →