Interface UpdateStackRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CloudFormationRequest.Builder
,CopyableBuilder<UpdateStackRequest.Builder,
,UpdateStackRequest> SdkBuilder<UpdateStackRequest.Builder,
,UpdateStackRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
UpdateStackRequest
-
Method Summary
Modifier and TypeMethodDescriptioncapabilities
(Collection<Capability> capabilities) In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack.capabilities
(Capability... capabilities) In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack.capabilitiesWithStrings
(String... capabilities) In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack.capabilitiesWithStrings
(Collection<String> capabilities) In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack.clientRequestToken
(String clientRequestToken) A unique identifier for thisUpdateStack
request.disableRollback
(Boolean disableRollback) Preserve the state of previously provisioned resources when an operation fails.notificationARNs
(String... notificationARNs) Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation associates with the stack.notificationARNs
(Collection<String> notificationARNs) Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation associates with the stack.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.parameters
(Collection<Parameter> parameters) A list ofParameter
structures that specify input parameters for the stack.parameters
(Consumer<Parameter.Builder>... parameters) A list ofParameter
structures that specify input parameters for the stack.parameters
(Parameter... parameters) A list ofParameter
structures that specify input parameters for the stack.resourceTypes
(String... resourceTypes) The template resource types that you have permissions to work with for this update stack action, such asAWS::EC2::Instance
,AWS::EC2::*
, orCustom::MyCustomInstance
.resourceTypes
(Collection<String> resourceTypes) The template resource types that you have permissions to work with for this update stack action, such asAWS::EC2::Instance
,AWS::EC2::*
, orCustom::MyCustomInstance
.retainExceptOnCreate
(Boolean retainExceptOnCreate) When set totrue
, newly created resources are deleted when the operation rolls back.The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to update the stack.default UpdateStackRequest.Builder
rollbackConfiguration
(Consumer<RollbackConfiguration.Builder> rollbackConfiguration) The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.rollbackConfiguration
(RollbackConfiguration rollbackConfiguration) The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.The name or unique stack ID of the stack to update.stackPolicyBody
(String stackPolicyBody) Structure containing a new stack policy body.stackPolicyDuringUpdateBody
(String stackPolicyDuringUpdateBody) Structure containing the temporary overriding stack policy body.stackPolicyDuringUpdateURL
(String stackPolicyDuringUpdateURL) Location of a file containing the temporary overriding stack policy.stackPolicyURL
(String stackPolicyURL) Location of a file containing the updated stack policy.tags
(Collection<Tag> tags) Key-value pairs to associate with this stack.tags
(Consumer<Tag.Builder>... tags) Key-value pairs to associate with this stack.Key-value pairs to associate with this stack.templateBody
(String templateBody) Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.templateURL
(String templateURL) Location of file containing the template body.usePreviousTemplate
(Boolean usePreviousTemplate) Reuse the existing template that is associated with the stack that you are updating.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.services.cloudformation.model.CloudFormationRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
stackName
The name or unique stack ID of the stack to update.
- Parameters:
stackName
- The name or unique stack ID of the stack to update.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
templateBody
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.
Conditional: You must specify only one of the following parameters:
TemplateBody
,TemplateURL
, or set theUsePreviousTemplate
totrue
.- Parameters:
templateBody
- Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.Conditional: You must specify only one of the following parameters:
TemplateBody
,TemplateURL
, or set theUsePreviousTemplate
totrue
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
templateURL
Location of file containing the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with
https://
.Conditional: You must specify only one of the following parameters:
TemplateBody
,TemplateURL
, or set theUsePreviousTemplate
totrue
.- Parameters:
templateURL
- Location of file containing the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start withhttps://
.Conditional: You must specify only one of the following parameters:
TemplateBody
,TemplateURL
, or set theUsePreviousTemplate
totrue
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
usePreviousTemplate
Reuse the existing template that is associated with the stack that you are updating.
Conditional: You must specify only one of the following parameters:
TemplateBody
,TemplateURL
, or set theUsePreviousTemplate
totrue
.- Parameters:
usePreviousTemplate
- Reuse the existing template that is associated with the stack that you are updating.Conditional: You must specify only one of the following parameters:
TemplateBody
,TemplateURL
, or set theUsePreviousTemplate
totrue
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
stackPolicyDuringUpdateBody
Structure containing the temporary overriding stack policy body. You can specify either the
StackPolicyDuringUpdateBody
or theStackPolicyDuringUpdateURL
parameter, but not both.If you want to update protected resources, specify a temporary overriding stack policy during this update. If you don't specify a stack policy, the current policy that is associated with the stack will be used.
- Parameters:
stackPolicyDuringUpdateBody
- Structure containing the temporary overriding stack policy body. You can specify either theStackPolicyDuringUpdateBody
or theStackPolicyDuringUpdateURL
parameter, but not both.If you want to update protected resources, specify a temporary overriding stack policy during this update. If you don't specify a stack policy, the current policy that is associated with the stack will be used.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
stackPolicyDuringUpdateURL
Location of a file containing the temporary overriding stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same Region as the stack. The location for an Amazon S3 bucket must start with
https://
. You can specify either theStackPolicyDuringUpdateBody
or theStackPolicyDuringUpdateURL
parameter, but not both.If you want to update protected resources, specify a temporary overriding stack policy during this update. If you don't specify a stack policy, the current policy that is associated with the stack will be used.
- Parameters:
stackPolicyDuringUpdateURL
- Location of a file containing the temporary overriding stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same Region as the stack. The location for an Amazon S3 bucket must start withhttps://
. You can specify either theStackPolicyDuringUpdateBody
or theStackPolicyDuringUpdateURL
parameter, but not both.If you want to update protected resources, specify a temporary overriding stack policy during this update. If you don't specify a stack policy, the current policy that is associated with the stack will be used.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
parameters
A list of
Parameter
structures that specify input parameters for the stack. For more information, see the Parameter data type.- Parameters:
parameters
- A list ofParameter
structures that specify input parameters for the stack. For more information, see the Parameter data type.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
parameters
A list of
Parameter
structures that specify input parameters for the stack. For more information, see the Parameter data type.- Parameters:
parameters
- A list ofParameter
structures that specify input parameters for the stack. For more information, see the Parameter data type.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
parameters
A list of
This is a convenience method that creates an instance of theParameter
structures that specify input parameters for the stack. For more information, see the Parameter data type.Parameter.Builder
avoiding the need to create one manually viaParameter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toparameters(List<Parameter>)
.- Parameters:
parameters
- a consumer that will call methods onParameter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
capabilitiesWithStrings
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack.
-
CAPABILITY_IAM
andCAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account, for example, by creating new 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
orCAPABILITY_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, CloudFormation returns an
InsufficientCapabilities
error.
If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM resources in 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 updating the stack. If your stack template contains one or more macros, and you choose to update 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 CloudFormation.
If you want to update a stack from a stack template that contains macros and nested stacks, you must update the stack directly from the template using this capability.
You should only update 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 CloudFormation being notified.
For more information, see Perform custom processing on CloudFormation templates with template macros.
Only one of the
Capabilities
andResourceType
parameters can be specified.- Parameters:
capabilities
- In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack.-
CAPABILITY_IAM
andCAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account, for example, by creating new 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
orCAPABILITY_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, CloudFormation returns an
InsufficientCapabilities
error.
If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM resources in 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 updating the stack. If your stack template contains one or more macros, and you choose to update 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 CloudFormation.
If you want to update a stack from a stack template that contains macros and nested stacks, you must update the stack directly from the template using this capability.
You should only update 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 CloudFormation being notified.
For more information, see Perform custom processing on CloudFormation templates with template macros.
Only one of the
Capabilities
andResourceType
parameters can be specified.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
capabilitiesWithStrings
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack.
-
CAPABILITY_IAM
andCAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account, for example, by creating new 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
orCAPABILITY_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, CloudFormation returns an
InsufficientCapabilities
error.
If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM resources in 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 updating the stack. If your stack template contains one or more macros, and you choose to update 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 CloudFormation.
If you want to update a stack from a stack template that contains macros and nested stacks, you must update the stack directly from the template using this capability.
You should only update 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 CloudFormation being notified.
For more information, see Perform custom processing on CloudFormation templates with template macros.
Only one of the
Capabilities
andResourceType
parameters can be specified.- Parameters:
capabilities
- In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack.-
CAPABILITY_IAM
andCAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account, for example, by creating new 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
orCAPABILITY_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, CloudFormation returns an
InsufficientCapabilities
error.
If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM resources in 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 updating the stack. If your stack template contains one or more macros, and you choose to update 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 CloudFormation.
If you want to update a stack from a stack template that contains macros and nested stacks, you must update the stack directly from the template using this capability.
You should only update 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 CloudFormation being notified.
For more information, see Perform custom processing on CloudFormation templates with template macros.
Only one of the
Capabilities
andResourceType
parameters can be specified.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
capabilities
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack.
-
CAPABILITY_IAM
andCAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account, for example, by creating new 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
orCAPABILITY_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, CloudFormation returns an
InsufficientCapabilities
error.
If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM resources in 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 updating the stack. If your stack template contains one or more macros, and you choose to update 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 CloudFormation.
If you want to update a stack from a stack template that contains macros and nested stacks, you must update the stack directly from the template using this capability.
You should only update 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 CloudFormation being notified.
For more information, see Perform custom processing on CloudFormation templates with template macros.
Only one of the
Capabilities
andResourceType
parameters can be specified.- Parameters:
capabilities
- In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack.-
CAPABILITY_IAM
andCAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account, for example, by creating new 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
orCAPABILITY_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, CloudFormation returns an
InsufficientCapabilities
error.
If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM resources in 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 updating the stack. If your stack template contains one or more macros, and you choose to update 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 CloudFormation.
If you want to update a stack from a stack template that contains macros and nested stacks, you must update the stack directly from the template using this capability.
You should only update 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 CloudFormation being notified.
For more information, see Perform custom processing on CloudFormation templates with template macros.
Only one of the
Capabilities
andResourceType
parameters can be specified.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
capabilities
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack.
-
CAPABILITY_IAM
andCAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account, for example, by creating new 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
orCAPABILITY_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, CloudFormation returns an
InsufficientCapabilities
error.
If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM resources in 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 updating the stack. If your stack template contains one or more macros, and you choose to update 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 CloudFormation.
If you want to update a stack from a stack template that contains macros and nested stacks, you must update the stack directly from the template using this capability.
You should only update 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 CloudFormation being notified.
For more information, see Perform custom processing on CloudFormation templates with template macros.
Only one of the
Capabilities
andResourceType
parameters can be specified.- Parameters:
capabilities
- In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack.-
CAPABILITY_IAM
andCAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account, for example, by creating new 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
orCAPABILITY_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, CloudFormation returns an
InsufficientCapabilities
error.
If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM resources in 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 updating the stack. If your stack template contains one or more macros, and you choose to update 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 CloudFormation.
If you want to update a stack from a stack template that contains macros and nested stacks, you must update the stack directly from the template using this capability.
You should only update 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 CloudFormation being notified.
For more information, see Perform custom processing on CloudFormation templates with template macros.
Only one of the
Capabilities
andResourceType
parameters can be specified.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
resourceTypes
The template resource types that you have permissions to work with for this update stack action, such as
AWS::EC2::Instance
,AWS::EC2::*
, orCustom::MyCustomInstance
.If the list of resource types doesn't include a resource that you're updating, the stack update fails. By default, CloudFormation grants permissions to all resource types. IAM uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Control access with Identity and Access Management.
Only one of the
Capabilities
andResourceType
parameters can be specified.- Parameters:
resourceTypes
- The template resource types that you have permissions to work with for this update stack action, such asAWS::EC2::Instance
,AWS::EC2::*
, orCustom::MyCustomInstance
.If the list of resource types doesn't include a resource that you're updating, the stack update fails. By default, CloudFormation grants permissions to all resource types. IAM uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Control access with Identity and Access Management.
Only one of the
Capabilities
andResourceType
parameters can be specified.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
resourceTypes
The template resource types that you have permissions to work with for this update stack action, such as
AWS::EC2::Instance
,AWS::EC2::*
, orCustom::MyCustomInstance
.If the list of resource types doesn't include a resource that you're updating, the stack update fails. By default, CloudFormation grants permissions to all resource types. IAM uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Control access with Identity and Access Management.
Only one of the
Capabilities
andResourceType
parameters can be specified.- Parameters:
resourceTypes
- The template resource types that you have permissions to work with for this update stack action, such asAWS::EC2::Instance
,AWS::EC2::*
, orCustom::MyCustomInstance
.If the list of resource types doesn't include a resource that you're updating, the stack update fails. By default, CloudFormation grants permissions to all resource types. IAM uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Control access with Identity and Access Management.
Only one of the
Capabilities
andResourceType
parameters can be specified.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
roleARN
The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to update the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, 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, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials.
- Parameters:
roleARN
- The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to update the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, 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, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
rollbackConfiguration
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
- Parameters:
rollbackConfiguration
- The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
rollbackConfiguration
default UpdateStackRequest.Builder rollbackConfiguration(Consumer<RollbackConfiguration.Builder> rollbackConfiguration) The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
This is a convenience method that creates an instance of theRollbackConfiguration.Builder
avoiding the need to create one manually viaRollbackConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed torollbackConfiguration(RollbackConfiguration)
.- Parameters:
rollbackConfiguration
- a consumer that will call methods onRollbackConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
stackPolicyBody
Structure containing a new stack policy body. You can specify either the
StackPolicyBody
or theStackPolicyURL
parameter, but not both.You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you don't specify a stack policy, the current policy that is associated with the stack is unchanged.
- Parameters:
stackPolicyBody
- Structure containing a new stack policy body. You can specify either theStackPolicyBody
or theStackPolicyURL
parameter, but not both.You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you don't specify a stack policy, the current policy that is associated with the stack is unchanged.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
stackPolicyURL
Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same Region as the stack. The location for an Amazon S3 bucket must start with
https://
. You can specify either theStackPolicyBody
or theStackPolicyURL
parameter, but not both.You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you don't specify a stack policy, the current policy that is associated with the stack is unchanged.
- Parameters:
stackPolicyURL
- Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same Region as the stack. The location for an Amazon S3 bucket must start withhttps://
. You can specify either theStackPolicyBody
or theStackPolicyURL
parameter, but not both.You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you don't specify a stack policy, the current policy that is associated with the stack is unchanged.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
notificationARNs
Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation associates with the stack. Specify an empty list to remove all notification topics.
- Parameters:
notificationARNs
- Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation associates with the stack. Specify an empty list to remove all notification topics.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
notificationARNs
Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation associates with the stack. Specify an empty list to remove all notification topics.
- Parameters:
notificationARNs
- Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation associates with the stack. Specify an empty list to remove all notification topics.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
Key-value pairs to associate with this stack. CloudFormation also propagates these tags to supported resources in the stack. You can specify a maximum number of 50 tags.
If you don't specify this parameter, CloudFormation doesn't modify the stack's tags. If you specify an empty value, CloudFormation removes all associated tags.
- Parameters:
tags
- Key-value pairs to associate with this stack. CloudFormation also propagates these tags to supported resources in the stack. You can specify a maximum number of 50 tags.If you don't specify this parameter, CloudFormation doesn't modify the stack's tags. If you specify an empty value, CloudFormation removes all associated tags.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
Key-value pairs to associate with this stack. CloudFormation also propagates these tags to supported resources in the stack. You can specify a maximum number of 50 tags.
If you don't specify this parameter, CloudFormation doesn't modify the stack's tags. If you specify an empty value, CloudFormation removes all associated tags.
- Parameters:
tags
- Key-value pairs to associate with this stack. CloudFormation also propagates these tags to supported resources in the stack. You can specify a maximum number of 50 tags.If you don't specify this parameter, CloudFormation doesn't modify the stack's tags. If you specify an empty value, CloudFormation removes all associated tags.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
Key-value pairs to associate with this stack. CloudFormation also propagates these tags to supported resources in the stack. You can specify a maximum number of 50 tags.
If you don't specify this parameter, CloudFormation doesn't modify the stack's tags. If you specify an empty value, CloudFormation removes all associated tags.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
disableRollback
Preserve the state of previously provisioned resources when an operation fails.
Default:
False
- Parameters:
disableRollback
- Preserve the state of previously provisioned resources when an operation fails.Default:
False
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
clientRequestToken
A unique identifier for this
UpdateStack
request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to update a stack with the same name. You might retryUpdateStack
requests to ensure that 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 tokentoken1
, then all theStackEvents
generated by that operation will haveClientRequestToken
set astoken1
.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
.- Parameters:
clientRequestToken
- A unique identifier for thisUpdateStack
request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to update a stack with the same name. You might retryUpdateStack
requests to ensure that 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 tokentoken1
, then all theStackEvents
generated by that operation will haveClientRequestToken
set astoken1
.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
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
retainExceptOnCreate
When set to
true
, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy ofRetain
.Default:
false
- Parameters:
retainExceptOnCreate
- When set totrue
, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy ofRetain
.Default:
false
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
UpdateStackRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
UpdateStackRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-