public static interface CreateStackRequest.Builder extends CloudFormationRequest.Builder, SdkPojo, CopyableBuilder<CreateStackRequest.Builder,CreateStackRequest>
| Modifier and Type | Method and Description |
|---|---|
CreateStackRequest.Builder |
capabilities(Capability... capabilities)
In some cases, you must explicity acknowledge that your stack template contains certain capabilities in order
for AWS CloudFormation to create the stack.
|
CreateStackRequest.Builder |
capabilities(Collection<Capability> capabilities)
In some cases, you must explicity acknowledge that your stack template contains certain capabilities in order
for AWS CloudFormation to create the stack.
|
CreateStackRequest.Builder |
capabilitiesWithStrings(Collection<String> capabilities)
In some cases, you must explicity acknowledge that your stack template contains certain capabilities in order
for AWS CloudFormation to create the stack.
|
CreateStackRequest.Builder |
capabilitiesWithStrings(String... capabilities)
In some cases, you must explicity acknowledge that your stack template contains certain capabilities in order
for AWS CloudFormation to create the stack.
|
CreateStackRequest.Builder |
clientRequestToken(String clientRequestToken)
A unique identifier for this
CreateStack request. |
CreateStackRequest.Builder |
disableRollback(Boolean disableRollback)
Set to
true to disable rollback of the stack if stack creation failed. |
CreateStackRequest.Builder |
enableTerminationProtection(Boolean enableTerminationProtection)
Whether to enable termination protection on the specified stack.
|
CreateStackRequest.Builder |
notificationARNs(Collection<String> notificationARNs)
The Simple Notification Service (SNS) topic ARNs to publish stack related events.
|
CreateStackRequest.Builder |
notificationARNs(String... notificationARNs)
The Simple Notification Service (SNS) topic ARNs to publish stack related events.
|
CreateStackRequest.Builder |
onFailure(OnFailure onFailure)
Determines what action will be taken if stack creation fails.
|
CreateStackRequest.Builder |
onFailure(String onFailure)
Determines what action will be taken if stack creation fails.
|
CreateStackRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
CreateStackRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
CreateStackRequest.Builder |
parameters(Collection<Parameter> parameters)
A list of
Parameter structures that specify input parameters for the stack. |
CreateStackRequest.Builder |
parameters(Consumer<Parameter.Builder>... parameters)
A list of
Parameter structures that specify input parameters for the stack. |
CreateStackRequest.Builder |
parameters(Parameter... parameters)
A list of
Parameter structures that specify input parameters for the stack. |
CreateStackRequest.Builder |
resourceTypes(Collection<String> resourceTypes)
The template resource types that you have permissions to work with for this create stack action, such as
AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. |
CreateStackRequest.Builder |
resourceTypes(String... resourceTypes)
The template resource types that you have permissions to work with for this create stack action, such as
AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. |
CreateStackRequest.Builder |
roleARN(String roleARN)
The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation
assumes to create the stack.
|
default CreateStackRequest.Builder |
rollbackConfiguration(Consumer<RollbackConfiguration.Builder> rollbackConfiguration)
The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and
for the specified monitoring period afterwards.
|
CreateStackRequest.Builder |
rollbackConfiguration(RollbackConfiguration rollbackConfiguration)
The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and
for the specified monitoring period afterwards.
|
CreateStackRequest.Builder |
stackName(String stackName)
The name that is associated with the stack.
|
CreateStackRequest.Builder |
stackPolicyBody(String stackPolicyBody)
Structure containing the stack policy body.
|
CreateStackRequest.Builder |
stackPolicyURL(String stackPolicyURL)
Location of a file containing the stack policy.
|
CreateStackRequest.Builder |
tags(Collection<Tag> tags)
Key-value pairs to associate with this stack.
|
CreateStackRequest.Builder |
tags(Consumer<Tag.Builder>... tags)
Key-value pairs to associate with this stack.
|
CreateStackRequest.Builder |
tags(Tag... tags)
Key-value pairs to associate with this stack.
|
CreateStackRequest.Builder |
templateBody(String templateBody)
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.
|
CreateStackRequest.Builder |
templateURL(String templateURL)
Location of file containing the template body.
|
CreateStackRequest.Builder |
timeoutInMinutes(Integer timeoutInMinutes)
The amount of time that can pass before the stack status becomes CREATE_FAILED; if
DisableRollback is not set or is set to false, the stack will be rolled back. |
buildoverrideConfigurationcopyapplyMutation, buildCreateStackRequest.Builder stackName(String stackName)
The name that is associated with the stack. The name must be unique in the region in which you are creating the stack.
A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an alphabetic character and cannot be longer than 128 characters.
stackName - The name that is associated with the stack. The name must be unique in the region in which you are
creating the stack. A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an alphabetic character and cannot be longer than 128 characters.
CreateStackRequest.Builder templateBody(String templateBody)
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must specify either the TemplateBody or the TemplateURL parameter,
but not both.
templateBody - Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200
bytes. For more information, go to Template
Anatomy in the AWS CloudFormation User Guide.
Conditional: You must specify either the TemplateBody or the TemplateURL
parameter, but not both.
CreateStackRequest.Builder templateURL(String templateURL)
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, go to the Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must specify either the TemplateBody or the TemplateURL parameter,
but not both.
templateURL - Location of file containing the template body. The URL must point to a template (max size: 460,800
bytes) that is located in an Amazon S3 bucket. For more information, go to the Template
Anatomy in the AWS CloudFormation User Guide.
Conditional: You must specify either the TemplateBody or the TemplateURL
parameter, but not both.
CreateStackRequest.Builder parameters(Collection<Parameter> parameters)
A list of Parameter structures that specify input parameters for the stack. For more
information, see the Parameter data
type.
parameters - A list of Parameter structures that specify input parameters for the stack. For more
information, see the Parameter data type.CreateStackRequest.Builder parameters(Parameter... parameters)
A list of Parameter structures that specify input parameters for the stack. For more
information, see the Parameter data
type.
parameters - A list of Parameter structures that specify input parameters for the stack. For more
information, see the Parameter data type.CreateStackRequest.Builder parameters(Consumer<Parameter.Builder>... parameters)
A list of Parameter structures that specify input parameters for the stack. For more
information, see the Parameter data
type.
List.Builder avoiding the need to
create one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately and its
result is passed to #parameters(List) .parameters - a consumer that will call methods on List.Builder #parameters(List) CreateStackRequest.Builder disableRollback(Boolean disableRollback)
Set to true to disable rollback of the stack if stack creation failed. You can specify either
DisableRollback or OnFailure, but not both.
Default: false
disableRollback - Set to true to disable rollback of the stack if stack creation failed. You can specify
either DisableRollback or OnFailure, but not both.
Default: false
CreateStackRequest.Builder rollbackConfiguration(RollbackConfiguration rollbackConfiguration)
The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
rollbackConfiguration - The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations,
and for the specified monitoring period afterwards.default CreateStackRequest.Builder rollbackConfiguration(Consumer<RollbackConfiguration.Builder> rollbackConfiguration)
The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
This is a convenience that creates an instance of theRollbackConfiguration.Builder avoiding the need
to create one manually via RollbackConfiguration.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and
its result is passed to rollbackConfiguration(RollbackConfiguration).rollbackConfiguration - a consumer that will call methods on RollbackConfiguration.BuilderrollbackConfiguration(RollbackConfiguration)CreateStackRequest.Builder timeoutInMinutes(Integer timeoutInMinutes)
The amount of time that can pass before the stack status becomes CREATE_FAILED; if
DisableRollback is not set or is set to false, the stack will be rolled back.
timeoutInMinutes - The amount of time that can pass before the stack status becomes CREATE_FAILED; if
DisableRollback is not set or is set to false, the stack will be rolled
back.CreateStackRequest.Builder notificationARNs(Collection<String> notificationARNs)
The Simple Notification Service (SNS) topic ARNs to publish stack related events. You can find your SNS topic ARNs using the SNS console or your Command Line Interface (CLI).
notificationARNs - The Simple Notification Service (SNS) topic ARNs to publish stack related events. You can find your
SNS topic ARNs using the SNS console or your Command Line Interface (CLI).CreateStackRequest.Builder notificationARNs(String... notificationARNs)
The Simple Notification Service (SNS) topic ARNs to publish stack related events. You can find your SNS topic ARNs using the SNS console or your Command Line Interface (CLI).
notificationARNs - The Simple Notification Service (SNS) topic ARNs to publish stack related events. You can find your
SNS topic ARNs using the SNS console or your Command Line Interface (CLI).CreateStackRequest.Builder capabilitiesWithStrings(Collection<String> capabilities)
In some cases, you must explicity acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to create the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or
CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, AWS CloudFormation returns an
InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.
Change sets do not currently support nested stacks. If you want to create a stack from a stack template that contains macros and nested stacks, you must create the stack directly from the template using this capability.
You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without AWS CloudFormation being notified.
For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.
capabilities - In some cases, you must explicity acknowledge that your stack template contains certain capabilities
in order for AWS CloudFormation to create the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or
CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM
.
If you don't specify either of these capabilities, AWS CloudFormation returns an
InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.
Change sets do not currently support nested stacks. If you want to create a stack from a stack template that contains macros and nested stacks, you must create the stack directly from the template using this capability.
You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without AWS CloudFormation being notified.
For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.
CreateStackRequest.Builder capabilitiesWithStrings(String... capabilities)
In some cases, you must explicity acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to create the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or
CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, AWS CloudFormation returns an
InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.
Change sets do not currently support nested stacks. If you want to create a stack from a stack template that contains macros and nested stacks, you must create the stack directly from the template using this capability.
You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without AWS CloudFormation being notified.
For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.
capabilities - In some cases, you must explicity acknowledge that your stack template contains certain capabilities
in order for AWS CloudFormation to create the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or
CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM
.
If you don't specify either of these capabilities, AWS CloudFormation returns an
InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.
Change sets do not currently support nested stacks. If you want to create a stack from a stack template that contains macros and nested stacks, you must create the stack directly from the template using this capability.
You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without AWS CloudFormation being notified.
For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.
CreateStackRequest.Builder capabilities(Collection<Capability> capabilities)
In some cases, you must explicity acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to create the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or
CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, AWS CloudFormation returns an
InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.
Change sets do not currently support nested stacks. If you want to create a stack from a stack template that contains macros and nested stacks, you must create the stack directly from the template using this capability.
You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without AWS CloudFormation being notified.
For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.
capabilities - In some cases, you must explicity acknowledge that your stack template contains certain capabilities
in order for AWS CloudFormation to create the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or
CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM
.
If you don't specify either of these capabilities, AWS CloudFormation returns an
InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.
Change sets do not currently support nested stacks. If you want to create a stack from a stack template that contains macros and nested stacks, you must create the stack directly from the template using this capability.
You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without AWS CloudFormation being notified.
For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.
CreateStackRequest.Builder capabilities(Capability... capabilities)
In some cases, you must explicity acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to create the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or
CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, AWS CloudFormation returns an
InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.
Change sets do not currently support nested stacks. If you want to create a stack from a stack template that contains macros and nested stacks, you must create the stack directly from the template using this capability.
You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without AWS CloudFormation being notified.
For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.
capabilities - In some cases, you must explicity acknowledge that your stack template contains certain capabilities
in order for AWS CloudFormation to create the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or
CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM
.
If you don't specify either of these capabilities, AWS CloudFormation returns an
InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.
Change sets do not currently support nested stacks. If you want to create a stack from a stack template that contains macros and nested stacks, you must create the stack directly from the template using this capability.
You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without AWS CloudFormation being notified.
For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.
CreateStackRequest.Builder resourceTypes(Collection<String> resourceTypes)
The template resource types that you have permissions to work with for this create stack action, such as
AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. Use the
following syntax to describe template resource types: AWS::* (for all AWS resource),
Custom::* (for all custom resources), Custom::logical_ID (for a specific
custom resource), AWS::service_name::* (for all resources of a particular AWS service),
and AWS::service_name::resource_logical_ID (for a specific AWS resource).
If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with AWS Identity and Access Management.
resourceTypes - The template resource types that you have permissions to work with for this create stack action, such
as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance
. Use the following syntax to describe template resource types: AWS::* (for all AWS
resource), Custom::* (for all custom resources), Custom::logical_ID
(for a specific custom resource), AWS::service_name::* (for all resources of a
particular AWS service), and AWS::service_name::resource_logical_ID (for a
specific AWS resource).
If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with AWS Identity and Access Management.
CreateStackRequest.Builder resourceTypes(String... resourceTypes)
The template resource types that you have permissions to work with for this create stack action, such as
AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. Use the
following syntax to describe template resource types: AWS::* (for all AWS resource),
Custom::* (for all custom resources), Custom::logical_ID (for a specific
custom resource), AWS::service_name::* (for all resources of a particular AWS service),
and AWS::service_name::resource_logical_ID (for a specific AWS resource).
If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with AWS Identity and Access Management.
resourceTypes - The template resource types that you have permissions to work with for this create stack action, such
as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance
. Use the following syntax to describe template resource types: AWS::* (for all AWS
resource), Custom::* (for all custom resources), Custom::logical_ID
(for a specific custom resource), AWS::service_name::* (for all resources of a
particular AWS service), and AWS::service_name::resource_logical_ID (for a
specific AWS resource).
If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with AWS Identity and Access Management.
CreateStackRequest.Builder roleARN(String roleARN)
The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to create the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.
If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.
roleARN - The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS
CloudFormation assumes to create the stack. AWS CloudFormation uses the role's credentials to make
calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack.
As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if
the users don't have permission to pass it. Ensure that the role grants least privilege.
If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.
CreateStackRequest.Builder onFailure(String onFailure)
Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or
DELETE. You can specify either OnFailure or DisableRollback, but not both.
Default: ROLLBACK
onFailure - Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING,
ROLLBACK, or DELETE. You can specify either OnFailure or DisableRollback,
but not both.
Default: ROLLBACK
OnFailure,
OnFailureCreateStackRequest.Builder onFailure(OnFailure onFailure)
Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or
DELETE. You can specify either OnFailure or DisableRollback, but not both.
Default: ROLLBACK
onFailure - Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING,
ROLLBACK, or DELETE. You can specify either OnFailure or DisableRollback,
but not both.
Default: ROLLBACK
OnFailure,
OnFailureCreateStackRequest.Builder stackPolicyBody(String stackPolicyBody)
Structure containing the stack policy body. For more information, go to Prevent
Updates to Stack Resources in the AWS CloudFormation User Guide. You can specify either the
StackPolicyBody or the StackPolicyURL parameter, but not both.
stackPolicyBody - Structure containing the stack policy body. For more information, go to
Prevent Updates to Stack Resources in the AWS CloudFormation User Guide. You can specify
either the StackPolicyBody or the StackPolicyURL parameter, but not both.CreateStackRequest.Builder stackPolicyURL(String stackPolicyURL)
Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located
in an S3 bucket in the same region as the stack. You can specify either the StackPolicyBody or
the StackPolicyURL parameter, but not both.
stackPolicyURL - Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB)
located in an S3 bucket in the same region as the stack. You can specify either the
StackPolicyBody or the StackPolicyURL parameter, but not both.CreateStackRequest.Builder tags(Collection<Tag> tags)
Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 50 tags can be specified.
tags - Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to the
resources created in the stack. A maximum number of 50 tags can be specified.CreateStackRequest.Builder tags(Tag... tags)
Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 50 tags can be specified.
tags - Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to the
resources created in the stack. A maximum number of 50 tags can be specified.CreateStackRequest.Builder tags(Consumer<Tag.Builder>... tags)
Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 50 tags can be specified.
This is a convenience that creates an instance of theList.Builder avoiding the need to create
one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately and its result
is passed to #tags(List) .tags - a consumer that will call methods on List.Builder #tags(List) CreateStackRequest.Builder clientRequestToken(String clientRequestToken)
A unique identifier for this CreateStack request. Specify this token if you plan to retry
requests so that AWS CloudFormation knows that you're not attempting to create a stack with the same name.
You might retry CreateStack requests to ensure that AWS CloudFormation successfully received
them.
All events triggered by a given stack operation are assigned the same client request token, which you can use
to track operations. For example, if you execute a CreateStack operation with the token
token1, then all the StackEvents generated by that operation will have
ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack operations that
are initiated from the console use the token format Console-StackOperation-ID, which helps you easily
identify the stack operation . For example, if you create a stack using the console, each stack event would
be assigned the same token in the following format:
Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
clientRequestToken - A unique identifier for this CreateStack request. Specify this token if you plan to retry
requests so that AWS CloudFormation knows that you're not attempting to create a stack with the same
name. You might retry CreateStack requests to ensure that AWS CloudFormation successfully
received them.
All events triggered by a given stack operation are assigned the same client request token, which you
can use to track operations. For example, if you execute a CreateStack operation with the
token token1, then all the StackEvents generated by that operation will have
ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack operations
that are initiated from the console use the token format Console-StackOperation-ID, which helps
you easily identify the stack operation . For example, if you create a stack using the console, each
stack event would be assigned the same token in the following format:
Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
CreateStackRequest.Builder enableTerminationProtection(Boolean enableTerminationProtection)
Whether to enable termination protection on the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide. Termination protection is disabled on stacks by default.
For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack.
enableTerminationProtection - Whether to enable termination protection on the specified stack. If a user attempts to delete a stack
with termination protection enabled, the operation fails and the stack remains unchanged. For more
information, see Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide. Termination
protection is disabled on stacks by default.
For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack.
CreateStackRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderoverrideConfiguration - The override configuration.CreateStackRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderbuilderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.