AwsCloudFormationStackProperties

All Known Implementing Classes:: AwsCloudFormationStackProperties.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-28T18:14:31.684Z")
public interface 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 software.amazon.awscdk.cloudassembly.schema.*;
 AwsCloudFormationStackProperties awsCloudFormationStackProperties = AwsCloudFormationStackProperties.builder()
         .templateFile("templateFile")
         // the properties below are optional
         .assumeRoleArn("assumeRoleArn")
         .assumeRoleExternalId("assumeRoleExternalId")
         .bootstrapStackVersionSsmParameter("bootstrapStackVersionSsmParameter")
         .cloudFormationExecutionRoleArn("cloudFormationExecutionRoleArn")
         .lookupRole(BootstrapRole.builder()
                 .arn("arn")
                 // the properties below are optional
                 .assumeRoleExternalId("assumeRoleExternalId")
                 .bootstrapStackVersionSsmParameter("bootstrapStackVersionSsmParameter")
                 .requiresBootstrapStackVersion(123)
                 .build())
         .parameters(Map.of(
                 "parametersKey", "parameters"))
         .requiresBootstrapStackVersion(123)
         .stackName("stackName")
         .stackTemplateAssetObjectUrl("stackTemplateAssetObjectUrl")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .terminationProtection(false)
         .validateOnSynth(false)
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`AwsCloudFormationStackProperties.Builder` A builder for `AwsCloudFormationStackProperties`
`static class`	`AwsCloudFormationStackProperties.Jsii$Proxy` An implementation for `AwsCloudFormationStackProperties`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static AwsCloudFormationStackProperties.Builder`	`builder()`
`default java.lang.String`	`getAssumeRoleArn()` The role that needs to be assumed to deploy the stack.
`default java.lang.String`	`getAssumeRoleExternalId()` External ID to use when assuming role for cloudformation deployments.
`default java.lang.String`	`getBootstrapStackVersionSsmParameter()` SSM parameter where the bootstrap stack version number can be found.
`default java.lang.String`	`getCloudFormationExecutionRoleArn()` The role that is passed to CloudFormation to execute the change set.
`default BootstrapRole`	`getLookupRole()` The role to use to look up values from the target AWS account.
`default java.util.Map<java.lang.String,java.lang.String>`	`getParameters()` Values for CloudFormation stack parameters that should be passed when the stack is deployed.
`default java.lang.Number`	`getRequiresBootstrapStackVersion()` Version of bootstrap stack required to deploy this stack.
`default java.lang.String`	`getStackName()` The name to use for the CloudFormation stack.
`default java.lang.String`	`getStackTemplateAssetObjectUrl()` If the stack template has already been included in the asset manifest, its asset URL.
`default java.util.Map<java.lang.String,java.lang.String>`	`getTags()` Values for CloudFormation stack tags that should be passed when the stack is deployed.
`java.lang.String`	`getTemplateFile()` A file relative to the assembly root which contains the CloudFormation template for this stack.
`default java.lang.Boolean`	`getTerminationProtection()` Whether to enable termination protection for this stack.
`default java.lang.Boolean`	`getValidateOnSynth()` Whether this stack should be validated by the CLI after synthesis.

- Method Detail
  - getTemplateFile
```
java.lang.String getTemplateFile()
```
    A file relative to the assembly root which contains the CloudFormation template for this stack.
  - getAssumeRoleArn
```
default java.lang.String getAssumeRoleArn()
```
    The role that needs to be assumed to deploy the stack.
    Default: - No role is assumed (current credentials are used)
  - getAssumeRoleExternalId
```
default java.lang.String getAssumeRoleExternalId()
```
    External ID to use when assuming role for cloudformation deployments.
    Default: - No external ID
  - getBootstrapStackVersionSsmParameter
```
default java.lang.String getBootstrapStackVersionSsmParameter()
```
    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.
    Default: - Bootstrap stack version number looked up
  - getCloudFormationExecutionRoleArn
```
default java.lang.String getCloudFormationExecutionRoleArn()
```
    The role that is passed to CloudFormation to execute the change set.
    Default: - No role is passed (currently assumed role/credentials are used)
  - getLookupRole
```
default BootstrapRole getLookupRole()
```
    The role to use to look up values from the target AWS account.
    Default: - No role is assumed (current credentials are used)
  - getParameters
```
default java.util.Map<java.lang.String,java.lang.String> getParameters()
```
    Values for CloudFormation stack parameters that should be passed when the stack is deployed.
    Default: - No parameters
  - getRequiresBootstrapStackVersion
```
default java.lang.Number getRequiresBootstrapStackVersion()
```
    Version of bootstrap stack required to deploy this stack.
    Default: - No bootstrap stack required
  - getStackName
```
default java.lang.String getStackName()
```
    The name to use for the CloudFormation stack.
    Default: - name derived from artifact ID
  - getStackTemplateAssetObjectUrl
```
default java.lang.String getStackTemplateAssetObjectUrl()
```
    If the stack template has already been included in the asset manifest, its asset URL.
    Default: - Not uploaded yet, upload just before deploying
  - getTags
```
default java.util.Map<java.lang.String,java.lang.String> getTags()
```
    Values for CloudFormation stack tags that should be passed when the stack is deployed.
    Default: - No tags
  - getTerminationProtection
```
default java.lang.Boolean getTerminationProtection()
```
    Whether to enable termination protection for this stack.
    Default: false
  - getValidateOnSynth
```
default java.lang.Boolean getValidateOnSynth()
```
    Whether this stack should be validated by the CLI after synthesis.
    Default: - false
  - builder
```
static AwsCloudFormationStackProperties.Builder builder()
```
    Returns:
    
    a AwsCloudFormationStackProperties.Builder of AwsCloudFormationStackProperties

Interface AwsCloudFormationStackProperties

Nested Class Summary

Method Summary

Method Detail

getTemplateFile

getAssumeRoleArn

getAssumeRoleExternalId

getBootstrapStackVersionSsmParameter

getCloudFormationExecutionRoleArn

getLookupRole

getParameters

getRequiresBootstrapStackVersion

getStackName

getStackTemplateAssetObjectUrl

getTags

getTerminationProtection

getValidateOnSynth

builder