UpdateStackRequest.Builder (AWS SDK for Java

All Superinterfaces:

AwsRequest.Builder, Buildable, CloudFormationRequest.Builder, CopyableBuilder<UpdateStackRequest.Builder,UpdateStackRequest>, SdkBuilder<UpdateStackRequest.Builder,UpdateStackRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UpdateStackRequest
```
public static interface UpdateStackRequest.Builder
extends CloudFormationRequest.Builder, SdkPojo, CopyableBuilder<UpdateStackRequest.Builder,UpdateStackRequest>
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`UpdateStackRequest.Builder`	`capabilities(Capability... capabilities)` In some cases, you must explicity acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to update the stack.
`UpdateStackRequest.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 update the stack.
`UpdateStackRequest.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 update the stack.
`UpdateStackRequest.Builder`	`capabilitiesWithStrings(String... capabilities)` In some cases, you must explicity acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to update the stack.
`UpdateStackRequest.Builder`	`clientRequestToken(String clientRequestToken)` A unique identifier for this `UpdateStack` request.
`UpdateStackRequest.Builder`	`notificationARNs(Collection<String> notificationARNs)` Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that AWS CloudFormation associates with the stack.
`UpdateStackRequest.Builder`	`notificationARNs(String... notificationARNs)` Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that AWS CloudFormation associates with the stack.
`UpdateStackRequest.Builder`	`overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)` Add an optional request override configuration.
`UpdateStackRequest.Builder`	`overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)` Add an optional request override configuration.
`UpdateStackRequest.Builder`	`parameters(Collection<Parameter> parameters)` A list of `Parameter` structures that specify input parameters for the stack.
`UpdateStackRequest.Builder`	`parameters(Consumer<Parameter.Builder>... parameters)` A list of `Parameter` structures that specify input parameters for the stack.
`UpdateStackRequest.Builder`	`parameters(Parameter... parameters)` A list of `Parameter` structures that specify input parameters for the stack.
`UpdateStackRequest.Builder`	`resourceTypes(Collection<String> resourceTypes)` The template resource types that you have permissions to work with for this update stack action, such as `AWS::EC2::Instance`, `AWS::EC2::*`, or `Custom::MyCustomInstance`.
`UpdateStackRequest.Builder`	`resourceTypes(String... resourceTypes)` The template resource types that you have permissions to work with for this update stack action, such as `AWS::EC2::Instance`, `AWS::EC2::*`, or `Custom::MyCustomInstance`.
`UpdateStackRequest.Builder`	`roleARN(String roleARN)` The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to update the stack.
`default UpdateStackRequest.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.
`UpdateStackRequest.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.
`UpdateStackRequest.Builder`	`stackName(String stackName)` The name or unique stack ID of the stack to update.
`UpdateStackRequest.Builder`	`stackPolicyBody(String stackPolicyBody)` Structure containing a new stack policy body.
`UpdateStackRequest.Builder`	`stackPolicyDuringUpdateBody(String stackPolicyDuringUpdateBody)` Structure containing the temporary overriding stack policy body.
`UpdateStackRequest.Builder`	`stackPolicyDuringUpdateURL(String stackPolicyDuringUpdateURL)` Location of a file containing the temporary overriding stack policy.
`UpdateStackRequest.Builder`	`stackPolicyURL(String stackPolicyURL)` Location of a file containing the updated stack policy.
`UpdateStackRequest.Builder`	`tags(Collection<Tag> tags)` Key-value pairs to associate with this stack.
`UpdateStackRequest.Builder`	`tags(Consumer<Tag.Builder>... tags)` Key-value pairs to associate with this stack.
`UpdateStackRequest.Builder`	`tags(Tag... tags)` Key-value pairs to associate with this stack.
`UpdateStackRequest.Builder`	`templateBody(String templateBody)` Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.
`UpdateStackRequest.Builder`	`templateURL(String templateURL)` Location of file containing the template body.
`UpdateStackRequest.Builder`	`usePreviousTemplate(Boolean usePreviousTemplate)` Reuse the existing template that is associated with the stack that you are updating.

Methods inherited from interface software.amazon.awssdk.services.cloudformation.model.CloudFormationRequest.Builder
build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - stackName
```
UpdateStackRequest.Builder stackName(String 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
```
UpdateStackRequest.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 only one of the following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.
    
    Parameters:
    
    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 only one of the following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - templateURL
```
UpdateStackRequest.Builder templateURL(String templateURL)
```
    Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.
    
    Conditional: You must specify only one of the following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.
    
    Parameters:
    
    templateURL - Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.
    
    Conditional: You must specify only one of the following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - usePreviousTemplate
```
UpdateStackRequest.Builder usePreviousTemplate(Boolean 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 the UsePreviousTemplate to true.
    
    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 the UsePreviousTemplate to true.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - stackPolicyDuringUpdateBody
```
UpdateStackRequest.Builder stackPolicyDuringUpdateBody(String stackPolicyDuringUpdateBody)
```
    Structure containing the temporary overriding stack policy body. You can specify either the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not both.
    
    If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not 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 the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not both.
    
    If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not 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
```
UpdateStackRequest.Builder stackPolicyDuringUpdateURL(String 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. You can specify either the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not both.
    
    If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not 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. You can specify either the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not both.
    
    If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not 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
```
UpdateStackRequest.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:
    
    parameters - A list of Parameter 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
```
UpdateStackRequest.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:
    
    parameters - A list of Parameter 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
```
UpdateStackRequest.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.
    This is a convenience that creates an instance of the 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:
    
    parameters - a consumer that will call methods on List.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #parameters(List)
  - capabilitiesWithStrings
```
UpdateStackRequest.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 update 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.
      
      AWS::IAM::AccessKey
      
      AWS::IAM::Group
      
      AWS::IAM::InstanceProfile
      
      AWS::IAM::Policy
      
      AWS::IAM::Role
      
      AWS::IAM::User
      
      AWS::IAM::UserToGroupAddition
      
      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 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 AWS CloudFormation.
      
      Change sets do not currently support nested stacks. 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 AWS CloudFormation being notified.
      
      For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.
    Parameters:
    capabilities - In some cases, you must explicity acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to update 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.
    
    AWS::IAM::AccessKey
    
    AWS::IAM::Group
    
    AWS::IAM::InstanceProfile
    
    AWS::IAM::Policy
    
    AWS::IAM::Role
    
    AWS::IAM::User
    
    AWS::IAM::UserToGroupAddition
    
    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 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 AWS CloudFormation.
    
    Change sets do not currently support nested stacks. 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 AWS CloudFormation being notified.
    
    For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - capabilitiesWithStrings
```
UpdateStackRequest.Builder capabilitiesWithStrings(String... capabilities)
```
    In some cases, you must explicity acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to update 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.
      
      AWS::IAM::AccessKey
      
      AWS::IAM::Group
      
      AWS::IAM::InstanceProfile
      
      AWS::IAM::Policy
      
      AWS::IAM::Role
      
      AWS::IAM::User
      
      AWS::IAM::UserToGroupAddition
      
      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 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 AWS CloudFormation.
      
      Change sets do not currently support nested stacks. 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 AWS CloudFormation being notified.
      
      For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.
    Parameters:
    capabilities - In some cases, you must explicity acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to update 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.
    
    AWS::IAM::AccessKey
    
    AWS::IAM::Group
    
    AWS::IAM::InstanceProfile
    
    AWS::IAM::Policy
    
    AWS::IAM::Role
    
    AWS::IAM::User
    
    AWS::IAM::UserToGroupAddition
    
    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 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 AWS CloudFormation.
    
    Change sets do not currently support nested stacks. 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 AWS CloudFormation being notified.
    
    For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - capabilities
```
UpdateStackRequest.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 update 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.
      
      AWS::IAM::AccessKey
      
      AWS::IAM::Group
      
      AWS::IAM::InstanceProfile
      
      AWS::IAM::Policy
      
      AWS::IAM::Role
      
      AWS::IAM::User
      
      AWS::IAM::UserToGroupAddition
      
      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 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 AWS CloudFormation.
      
      Change sets do not currently support nested stacks. 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 AWS CloudFormation being notified.
      
      For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.
    Parameters:
    capabilities - In some cases, you must explicity acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to update 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.
    
    AWS::IAM::AccessKey
    
    AWS::IAM::Group
    
    AWS::IAM::InstanceProfile
    
    AWS::IAM::Policy
    
    AWS::IAM::Role
    
    AWS::IAM::User
    
    AWS::IAM::UserToGroupAddition
    
    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 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 AWS CloudFormation.
    
    Change sets do not currently support nested stacks. 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 AWS CloudFormation being notified.
    
    For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - capabilities
```
UpdateStackRequest.Builder capabilities(Capability... capabilities)
```
    In some cases, you must explicity acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to update 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.
      
      AWS::IAM::AccessKey
      
      AWS::IAM::Group
      
      AWS::IAM::InstanceProfile
      
      AWS::IAM::Policy
      
      AWS::IAM::Role
      
      AWS::IAM::User
      
      AWS::IAM::UserToGroupAddition
      
      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 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 AWS CloudFormation.
      
      Change sets do not currently support nested stacks. 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 AWS CloudFormation being notified.
      
      For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.
    Parameters:
    capabilities - In some cases, you must explicity acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to update 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.
    
    AWS::IAM::AccessKey
    
    AWS::IAM::Group
    
    AWS::IAM::InstanceProfile
    
    AWS::IAM::Policy
    
    AWS::IAM::Role
    
    AWS::IAM::User
    
    AWS::IAM::UserToGroupAddition
    
    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 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 AWS CloudFormation.
    
    Change sets do not currently support nested stacks. 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 AWS CloudFormation being notified.
    
    For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - resourceTypes
```
UpdateStackRequest.Builder resourceTypes(Collection<String> resourceTypes)
```
    The template resource types that you have permissions to work with for this update stack action, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.
    
    If the list of resource types doesn't include a resource that you're updating, the stack update 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.
    
    Parameters:
    
    resourceTypes - The template resource types that you have permissions to work with for this update stack action, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance .
    
    If the list of resource types doesn't include a resource that you're updating, the stack update 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - resourceTypes
```
UpdateStackRequest.Builder resourceTypes(String... resourceTypes)
```
    The template resource types that you have permissions to work with for this update stack action, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.
    
    If the list of resource types doesn't include a resource that you're updating, the stack update 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.
    
    Parameters:
    
    resourceTypes - The template resource types that you have permissions to work with for this update stack action, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance .
    
    If the list of resource types doesn't include a resource that you're updating, the stack update 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - roleARN
```
UpdateStackRequest.Builder roleARN(String roleARN)
```
    The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to update 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.
    
    Parameters:
    
    roleARN - The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to update 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - rollbackConfiguration
```
UpdateStackRequest.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.
    
    Parameters:
    
    rollbackConfiguration - The rollback triggers for AWS 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 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 the RollbackConfiguration.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).
    
    Parameters:
    
    rollbackConfiguration - a consumer that will call methods on RollbackConfiguration.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    rollbackConfiguration(RollbackConfiguration)
  - stackPolicyBody
```
UpdateStackRequest.Builder stackPolicyBody(String stackPolicyBody)
```
    Structure containing a new stack policy body. You can specify either the StackPolicyBody or the StackPolicyURL 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 do not 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 the StackPolicyBody or the StackPolicyURL 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 do not 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
```
UpdateStackRequest.Builder stackPolicyURL(String 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. You can specify either the StackPolicyBody or the StackPolicyURL 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 do not 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. You can specify either the StackPolicyBody or the StackPolicyURL 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 do not 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
```
UpdateStackRequest.Builder notificationARNs(Collection<String> notificationARNs)
```
    Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that AWS 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 AWS 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
```
UpdateStackRequest.Builder notificationARNs(String... notificationARNs)
```
    Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that AWS 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 AWS 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
```
UpdateStackRequest.Builder tags(Collection<Tag> tags)
```
    Key-value pairs to associate with this stack. AWS 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, AWS CloudFormation doesn't modify the stack's tags. If you specify an empty value, AWS CloudFormation removes all associated tags.
    
    Parameters:
    
    tags - Key-value pairs to associate with this stack. AWS 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, AWS CloudFormation doesn't modify the stack's tags. If you specify an empty value, AWS CloudFormation removes all associated tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - tags
```
UpdateStackRequest.Builder tags(Tag... tags)
```
    Key-value pairs to associate with this stack. AWS 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, AWS CloudFormation doesn't modify the stack's tags. If you specify an empty value, AWS CloudFormation removes all associated tags.
    
    Parameters:
    
    tags - Key-value pairs to associate with this stack. AWS 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, AWS CloudFormation doesn't modify the stack's tags. If you specify an empty value, AWS CloudFormation removes all associated tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - tags
```
UpdateStackRequest.Builder tags(Consumer<Tag.Builder>... tags)
```
    Key-value pairs to associate with this stack. AWS 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, AWS CloudFormation doesn't modify the stack's tags. If you specify an empty value, AWS CloudFormation removes all associated tags.
    This is a convenience that creates an instance of the 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 #tags(List).
    
    Parameters:
    
    tags - a consumer that will call methods on List.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #tags(List)
  - clientRequestToken
```
UpdateStackRequest.Builder clientRequestToken(String clientRequestToken)
```
    A unique identifier for this UpdateStack request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to update a stack with the same name. You might retry UpdateStack 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.
    
    Parameters:
    
    clientRequestToken - A unique identifier for this UpdateStack request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to update a stack with the same name. You might retry UpdateStack 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.
    
    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 interface AwsRequest.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 interface AwsRequest.Builder
    
    Parameters:
    
    builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
    
    Returns:
    
    This object for method chaining.

Interface UpdateStackRequest.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.services.cloudformation.model.CloudFormationRequest.Builder

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

Method Detail

stackName

templateBody

templateURL

usePreviousTemplate

stackPolicyDuringUpdateBody

stackPolicyDuringUpdateURL

parameters

parameters

parameters

capabilitiesWithStrings

capabilitiesWithStrings

capabilities

capabilities

resourceTypes

resourceTypes

roleARN

rollbackConfiguration

rollbackConfiguration

stackPolicyBody

stackPolicyURL

notificationARNs

notificationARNs

tags

tags

tags

clientRequestToken

overrideConfiguration

overrideConfiguration