# AwsCloudFormationStackProperties

Artifact properties for CloudFormation stacks.

- Source: [`lib/cloud-assembly/artifact-schema.ts`](https://github.com/aws/aws-cdk-cli/blob/HEAD/packages/@aws-cdk/cloud-assembly-schema/lib/cloud-assembly/artifact-schema.ts)
- Type last changed: v2.160.0 · 24 Sep 2024

## Example

TypeScript:

```ts
// 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,
};
```

Python:

```python
from aws_cdk.cloud_assembly_schema import AwsCloudFormationStackProperties, BootstrapRole
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import cloud_assembly_schema

# assume_role_additional_options: Any

aws_cloud_formation_stack_properties = AwsCloudFormationStackProperties(
    template_file="templateFile",

    # the properties below are optional
    assume_role_additional_options={
        "assume_role_additional_options_key": assume_role_additional_options
    },
    assume_role_arn="assumeRoleArn",
    assume_role_external_id="assumeRoleExternalId",
    bootstrap_stack_version_ssm_parameter="bootstrapStackVersionSsmParameter",
    cloud_formation_execution_role_arn="cloudFormationExecutionRoleArn",
    lookup_role=BootstrapRole(
        arn="arn",

        # the properties below are optional
        assume_role_additional_options={
            "assume_role_additional_options_key": assume_role_additional_options
        },
        assume_role_external_id="assumeRoleExternalId",
        bootstrap_stack_version_ssm_parameter="bootstrapStackVersionSsmParameter",
        requires_bootstrap_stack_version=123
    ),
    notification_arns=["notificationArns"],
    parameters={
        "parameters_key": "parameters"
    },
    requires_bootstrap_stack_version=123,
    stack_name="stackName",
    stack_template_asset_object_url="stackTemplateAssetObjectUrl",
    tags={
        "tags_key": "tags"
    },
    termination_protection=False,
    validate_on_synth=False
)
```

Java:

```java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.cloud_assembly_schema.*;

Object assumeRoleAdditionalOptions;

AwsCloudFormationStackProperties awsCloudFormationStackProperties = AwsCloudFormationStackProperties.builder()
        .templateFile("templateFile")

        // the properties below are optional
        .assumeRoleAdditionalOptions(Map.of(
                "assumeRoleAdditionalOptionsKey", assumeRoleAdditionalOptions))
        .assumeRoleArn("assumeRoleArn")
        .assumeRoleExternalId("assumeRoleExternalId")
        .bootstrapStackVersionSsmParameter("bootstrapStackVersionSsmParameter")
        .cloudFormationExecutionRoleArn("cloudFormationExecutionRoleArn")
        .lookupRole(BootstrapRole.builder()
                .arn("arn")

                // the properties below are optional
                .assumeRoleAdditionalOptions(Map.of(
                        "assumeRoleAdditionalOptionsKey", assumeRoleAdditionalOptions))
                .assumeRoleExternalId("assumeRoleExternalId")
                .bootstrapStackVersionSsmParameter("bootstrapStackVersionSsmParameter")
                .requiresBootstrapStackVersion(123)
                .build())
        .notificationArns(List.of("notificationArns"))
        .parameters(Map.of(
                "parametersKey", "parameters"))
        .requiresBootstrapStackVersion(123)
        .stackName("stackName")
        .stackTemplateAssetObjectUrl("stackTemplateAssetObjectUrl")
        .tags(Map.of(
                "tagsKey", "tags"))
        .terminationProtection(false)
        .validateOnSynth(false)
        .build();
```

C# / .NET:

```csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.Cloud_assembly_schema;

var assumeRoleAdditionalOptions;

var awsCloudFormationStackProperties = new AwsCloudFormationStackProperties {
    TemplateFile = "templateFile",

    // the properties below are optional
    AssumeRoleAdditionalOptions = new Dictionary<string, object> {
        { "assumeRoleAdditionalOptionsKey", assumeRoleAdditionalOptions }
    },
    AssumeRoleArn = "assumeRoleArn",
    AssumeRoleExternalId = "assumeRoleExternalId",
    BootstrapStackVersionSsmParameter = "bootstrapStackVersionSsmParameter",
    CloudFormationExecutionRoleArn = "cloudFormationExecutionRoleArn",
    LookupRole = new BootstrapRole {
        Arn = "arn",

        // the properties below are optional
        AssumeRoleAdditionalOptions = new Dictionary<string, object> {
            { "assumeRoleAdditionalOptionsKey", assumeRoleAdditionalOptions }
        },
        AssumeRoleExternalId = "assumeRoleExternalId",
        BootstrapStackVersionSsmParameter = "bootstrapStackVersionSsmParameter",
        RequiresBootstrapStackVersion = 123
    },
    NotificationArns = new [] { "notificationArns" },
    Parameters = new Dictionary<string, string> {
        { "parametersKey", "parameters" }
    },
    RequiresBootstrapStackVersion = 123,
    StackName = "stackName",
    StackTemplateAssetObjectUrl = "stackTemplateAssetObjectUrl",
    Tags = new Dictionary<string, string> {
        { "tagsKey", "tags" }
    },
    TerminationProtection = false,
    ValidateOnSynth = false
};
```

Golang:

```go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var assumeRoleAdditionalOptions interface{}

awsCloudFormationStackProperties := &AwsCloudFormationStackProperties{
	TemplateFile: jsii.String("templateFile"),

	// the properties below are optional
	AssumeRoleAdditionalOptions: map[string]interface{}{
		"assumeRoleAdditionalOptionsKey": assumeRoleAdditionalOptions,
	},
	AssumeRoleArn: jsii.String("assumeRoleArn"),
	AssumeRoleExternalId: jsii.String("assumeRoleExternalId"),
	BootstrapStackVersionSsmParameter: jsii.String("bootstrapStackVersionSsmParameter"),
	CloudFormationExecutionRoleArn: jsii.String("cloudFormationExecutionRoleArn"),
	LookupRole: &BootstrapRole{
		Arn: jsii.String("arn"),

		// the properties below are optional
		AssumeRoleAdditionalOptions: map[string]interface{}{
			"assumeRoleAdditionalOptionsKey": assumeRoleAdditionalOptions,
		},
		AssumeRoleExternalId: jsii.String("assumeRoleExternalId"),
		BootstrapStackVersionSsmParameter: jsii.String("bootstrapStackVersionSsmParameter"),
		RequiresBootstrapStackVersion: jsii.Number(123),
	},
	NotificationArns: []*string{
		jsii.String("notificationArns"),
	},
	Parameters: map[string]*string{
		"parametersKey": jsii.String("parameters"),
	},
	RequiresBootstrapStackVersion: jsii.Number(123),
	StackName: jsii.String("stackName"),
	StackTemplateAssetObjectUrl: jsii.String("stackTemplateAssetObjectUrl"),
	Tags: map[string]*string{
		"tagsKey": jsii.String("tags"),
	},
	TerminationProtection: jsii.Boolean(false),
	ValidateOnSynth: jsii.Boolean(false),
}
```

## Properties

- `assumeRoleAdditionalOptions`: { [key: string]: any } — Additional options to pass to STS when assuming the role.

  **Default:** No additional options.

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

- `assumeRoleArn`: string — The role that needs to be assumed to deploy the stack.

  **Default:** No role is assumed (current credentials are used)

- `assumeRoleExternalId`: string — External ID to use when assuming role for cloudformation deployments.

  **Default:** No external ID

- `bootstrapStackVersionSsmParameter`: string — SSM parameter where the bootstrap stack version number can be found.

  **Default:** Bootstrap stack version number looked up

  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`: string — The role that is passed to CloudFormation to execute the change set.

  **Default:** No role is passed (currently assumed role/credentials are used)

- `lookupRole`: [BootstrapRole](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.cloud_assembly_schema.BootstrapRole.html) — The role to use to look up values from the target AWS account.

  **Default:** No role is assumed (current credentials are used)

- `notificationArns`: string[] — SNS Notification ARNs that should receive CloudFormation Stack Events.

  **Default:** No notification arns

- `parameters`: { [key: string]: string } — Values for CloudFormation stack parameters that should be passed when the stack is deployed.

  **Default:** No parameters

- `requiresBootstrapStackVersion`: number — Version of bootstrap stack required to deploy this stack.

  **Default:** No bootstrap stack required

- `stackName`: string — The name to use for the CloudFormation stack.

  **Default:** name derived from artifact ID

- `stackTemplateAssetObjectUrl`: string — If the stack template has already been included in the asset manifest, its asset URL.

  **Default:** Not uploaded yet, upload just before deploying

- `tags`: { [key: string]: string } — Values for CloudFormation stack tags that should be passed when the stack is deployed.

  **Default:** No tags

  N.B.: Tags are also written to stack metadata, under the path of the Stack
  construct. Only in CDK CLI v1 are those tags found in metadata used for
  actual deployments; in all stable versions of CDK only the stack tags
  directly found in the `tags` property of `AwsCloudFormationStack` artifact
  (i.e., this property) are used.

- `templateFile`: string (required) — A file relative to the assembly root which contains the CloudFormation template for this stack.

- `terminationProtection`: boolean = false — Whether to enable termination protection for this stack.

- `validateOnSynth`: boolean = false — Whether this stack should be validated by the CLI after synthesis.
