com.amazonaws.services.cloudformation.model.UpdateStackRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-cloudformation Show documentation
/*
* Copyright 2017-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.cloudformation.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* The input for an UpdateStack action.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class UpdateStackRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name or unique stack ID of the stack to update.
*
*/
private String stackName;
/**
*
* 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 CloudFormation User Guide.)
*
*
* Conditional: You must specify only one of the following parameters: TemplateBody,
* TemplateURL, or set the UsePreviousTemplate to true.
*
*/
private String templateBody;
/**
*
* Location of file containing the template body. The URL must point to a template that is located in an Amazon S3
* bucket or a Systems Manager document. For more information, go to Template Anatomy
* in the CloudFormation User Guide.
*
*
* Conditional: You must specify only one of the following parameters: TemplateBody,
* TemplateURL, or set the UsePreviousTemplate to true.
*
*/
private String templateURL;
/**
*
* 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.
*
*/
private Boolean usePreviousTemplate;
/**
*
* 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.
*
*/
private String stackPolicyDuringUpdateBody;
/**
*
* 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.
*
*/
private String stackPolicyDuringUpdateURL;
/**
*
* A list of Parameter structures that specify input parameters for the stack. For more information,
* see the Parameter data
* type.
*
*/
private com.amazonaws.internal.SdkInternalList parameters;
/**
*
* In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order
* for CloudFormation to update the stack.
*
*
* -
*
* CAPABILITY_IAM and CAPABILITY_NAMED_IAM
*
*
* Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for
* example, by creating new 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, 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::Role
*
*
* -
*
*
* AWS::IAM::User
*
*
* -
*
*
*
*
* 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 Using CloudFormation
* Macros to Perform Custom Processing on Templates.
*
*
*
*/
private com.amazonaws.internal.SdkInternalList capabilities;
/**
*
* 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, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this
* parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access
* with Identity and Access Management.
*
*/
private com.amazonaws.internal.SdkInternalList resourceTypes;
/**
*
* The Amazon Resource Name (ARN) of an Identity and Access Management (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. As long as 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.
*
*/
private String roleARN;
/**
*
* The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the
* specified monitoring period afterwards.
*
*/
private RollbackConfiguration rollbackConfiguration;
/**
*
* 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.
*
*/
private String stackPolicyBody;
/**
*
* 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.
*
*/
private String stackPolicyURL;
/**
*
* Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation associates with the
* stack. Specify an empty list to remove all notification topics.
*
*/
private com.amazonaws.internal.SdkInternalList notificationARNs;
/**
*
* 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.
*
*/
private com.amazonaws.internal.SdkInternalList tags;
/**
*
* Preserve the state of previously provisioned resources when an operation fails.
*
*
* Default: False
*
*/
private Boolean disableRollback;
/**
*
* 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 retry
* UpdateStack 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 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.
*
*/
private String clientRequestToken;
/**
*
* The name or unique stack ID of the stack to update.
*
*
* @param stackName
* The name or unique stack ID of the stack to update.
*/
public void setStackName(String stackName) {
this.stackName = stackName;
}
/**
*
* The name or unique stack ID of the stack to update.
*
*
* @return The name or unique stack ID of the stack to update.
*/
public String getStackName() {
return this.stackName;
}
/**
*
* The name or unique stack ID of the stack to update.
*
*
* @param stackName
* The name or unique stack ID of the stack to update.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateStackRequest withStackName(String stackName) {
setStackName(stackName);
return this;
}
/**
*
* 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 CloudFormation User Guide.)
*
*
* Conditional: You must specify only one of the following parameters: TemplateBody,
* TemplateURL, or set the UsePreviousTemplate to true.
*
*
* @param 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 CloudFormation User Guide.)
*
* Conditional: You must specify only one of the following parameters: TemplateBody,
* TemplateURL, or set the UsePreviousTemplate to true.
*/
public void setTemplateBody(String templateBody) {
this.templateBody = 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 CloudFormation User Guide.)
*
*
* Conditional: You must specify only one of the following parameters: TemplateBody,
* TemplateURL, or set the UsePreviousTemplate to true.
*
*
* @return 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 CloudFormation User Guide.)
*
* Conditional: You must specify only one of the following parameters: TemplateBody,
* TemplateURL, or set the UsePreviousTemplate to true.
*/
public String getTemplateBody() {
return this.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 CloudFormation User Guide.)
*
*
* Conditional: You must specify only one of the following parameters: TemplateBody,
* TemplateURL, or set the UsePreviousTemplate to true.
*
*
* @param 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 CloudFormation User Guide.)
*
* Conditional: You must specify only one of the following parameters: TemplateBody,
* TemplateURL, or set the UsePreviousTemplate to true.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateStackRequest withTemplateBody(String templateBody) {
setTemplateBody(templateBody);
return this;
}
/**
*
* Location of file containing the template body. The URL must point to a template that is located in an Amazon S3
* bucket or a Systems Manager document. For more information, go to Template Anatomy
* in the CloudFormation User Guide.
*
*
* Conditional: You must specify only one of the following parameters: TemplateBody,
* TemplateURL, or set the UsePreviousTemplate to true.
*
*
* @param templateURL
* Location of file containing the template body. The URL must point to a template that is located in an
* Amazon S3 bucket or a Systems Manager document. For more information, go to Template
* Anatomy in the CloudFormation User Guide.
*
* Conditional: You must specify only one of the following parameters: TemplateBody,
* TemplateURL, or set the UsePreviousTemplate to true.
*/
public void setTemplateURL(String templateURL) {
this.templateURL = templateURL;
}
/**
*
* Location of file containing the template body. The URL must point to a template that is located in an Amazon S3
* bucket or a Systems Manager document. For more information, go to Template Anatomy
* in the CloudFormation User Guide.
*
*
* Conditional: You must specify only one of the following parameters: TemplateBody,
* TemplateURL, or set the UsePreviousTemplate to true.
*
*
* @return Location of file containing the template body. The URL must point to a template that is located in an
* Amazon S3 bucket or a Systems Manager document. For more information, go to Template
* Anatomy in the CloudFormation User Guide.
*
* Conditional: You must specify only one of the following parameters: TemplateBody,
* TemplateURL, or set the UsePreviousTemplate to true.
*/
public String getTemplateURL() {
return this.templateURL;
}
/**
*
* Location of file containing the template body. The URL must point to a template that is located in an Amazon S3
* bucket or a Systems Manager document. For more information, go to Template Anatomy
* in the CloudFormation User Guide.
*
*
* Conditional: You must specify only one of the following parameters: TemplateBody,
* TemplateURL, or set the UsePreviousTemplate to true.
*
*
* @param templateURL
* Location of file containing the template body. The URL must point to a template that is located in an
* Amazon S3 bucket or a Systems Manager document. For more information, go to Template
* Anatomy in the CloudFormation User Guide.
*
* Conditional: You must specify only one of the following parameters: TemplateBody,
* TemplateURL, or set the UsePreviousTemplate to true.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateStackRequest withTemplateURL(String templateURL) {
setTemplateURL(templateURL);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setUsePreviousTemplate(Boolean usePreviousTemplate) {
this.usePreviousTemplate = 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.
*
*
* @return 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.
*/
public Boolean getUsePreviousTemplate() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateStackRequest withUsePreviousTemplate(Boolean usePreviousTemplate) {
setUsePreviousTemplate(usePreviousTemplate);
return this;
}
/**
*
* 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.
*
*
* @return 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.
*/
public Boolean isUsePreviousTemplate() {
return this.usePreviousTemplate;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setStackPolicyDuringUpdateBody(String stackPolicyDuringUpdateBody) {
this.stackPolicyDuringUpdateBody = 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.
*
*
* @return 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.
*/
public String getStackPolicyDuringUpdateBody() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateStackRequest withStackPolicyDuringUpdateBody(String stackPolicyDuringUpdateBody) {
setStackPolicyDuringUpdateBody(stackPolicyDuringUpdateBody);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setStackPolicyDuringUpdateURL(String stackPolicyDuringUpdateURL) {
this.stackPolicyDuringUpdateURL = 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.
*
*
* @return 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.
*/
public String getStackPolicyDuringUpdateURL() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateStackRequest withStackPolicyDuringUpdateURL(String stackPolicyDuringUpdateURL) {
setStackPolicyDuringUpdateURL(stackPolicyDuringUpdateURL);
return this;
}
/**
*
* A list of Parameter structures that specify input parameters for the stack. For more information,
* see the Parameter data
* type.
*
*
* @return A list of Parameter structures that specify input parameters for the stack. For more
* information, see the Parameter
* data type.
*/
public java.util.List getParameters() {
if (parameters == null) {
parameters = new com.amazonaws.internal.SdkInternalList();
}
return parameters;
}
/**
*
* A list of Parameter structures that specify input parameters for the stack. For more information,
* see the Parameter data
* type.
*
*
* @param parameters
* A list of Parameter structures that specify input parameters for the stack. For more
* information, see the Parameter
* data type.
*/
public void setParameters(java.util.Collection parameters) {
if (parameters == null) {
this.parameters = null;
return;
}
this.parameters = new com.amazonaws.internal.SdkInternalList(parameters);
}
/**
*
* A list of Parameter structures that specify input parameters for the stack. For more information,
* see the Parameter data
* type.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setParameters(java.util.Collection)} or {@link #withParameters(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param parameters
* A list of Parameter structures that specify input parameters for the stack. For more
* information, see the Parameter
* data type.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateStackRequest withParameters(Parameter... parameters) {
if (this.parameters == null) {
setParameters(new com.amazonaws.internal.SdkInternalList(parameters.length));
}
for (Parameter ele : parameters) {
this.parameters.add(ele);
}
return this;
}
/**
*
* A list of Parameter structures that specify input parameters for the stack. For more information,
* see the Parameter data
* type.
*
*
* @param parameters
* A list of Parameter structures that specify input parameters for the stack. For more
* information, see the Parameter
* data type.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateStackRequest withParameters(java.util.Collection parameters) {
setParameters(parameters);
return this;
}
/**
*
* In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order
* for CloudFormation to update the stack.
*
*
* -
*
* CAPABILITY_IAM and CAPABILITY_NAMED_IAM
*
*
* Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for
* example, by creating new 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, 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::Role
*
*
* -
*
*
* AWS::IAM::User
*
*
* -
*
*
*
*
* 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 Using CloudFormation
* Macros to Perform Custom Processing on Templates.
*
*
*
*
* @return In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in
* order for CloudFormation to update the stack.
*
* -
*
* CAPABILITY_IAM and CAPABILITY_NAMED_IAM
*
*
* Some stack templates might include resources that can affect permissions in your Amazon Web Services
* account; for example, by creating new 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, 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::Role
*
*
* -
*
*
* AWS::IAM::User
*
*
* -
*
*
*
*
* 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 Using
* CloudFormation Macros to Perform Custom Processing on Templates.
*
*
* @see Capability
*/
public java.util.List getCapabilities() {
if (capabilities == null) {
capabilities = new com.amazonaws.internal.SdkInternalList();
}
return 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 and CAPABILITY_NAMED_IAM
*
*
* Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for
* example, by creating new 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, 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::Role
*
*
* -
*
*
* AWS::IAM::User
*
*
* -
*
*
*
*
* 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 Using CloudFormation
* Macros to Perform Custom Processing on Templates.
*
*
*
*
* @param 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 and CAPABILITY_NAMED_IAM
*
*
* Some stack templates might include resources that can affect permissions in your Amazon Web Services
* account; for example, by creating new 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, 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::Role
*
*
* -
*
*
* AWS::IAM::User
*
*
* -
*
*
*
*
* 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 Using
* CloudFormation Macros to Perform Custom Processing on Templates.
*
*
* @see Capability
*/
public void setCapabilities(java.util.Collection capabilities) {
if (capabilities == null) {
this.capabilities = null;
return;
}
this.capabilities = new com.amazonaws.internal.SdkInternalList(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 and CAPABILITY_NAMED_IAM
*
*
* Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for
* example, by creating new 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, 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::Role
*
*
* -
*
*
* AWS::IAM::User
*
*
* -
*
*
*
*
* 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 Using CloudFormation
* Macros to Perform Custom Processing on Templates.
*
*
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setCapabilities(java.util.Collection)} or {@link #withCapabilities(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param 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 and CAPABILITY_NAMED_IAM
*
*
* Some stack templates might include resources that can affect permissions in your Amazon Web Services
* account; for example, by creating new 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, 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::Role
*
*
* -
*
*
* AWS::IAM::User
*
*
* -
*
*
*
*
* 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 Using
* CloudFormation Macros to Perform Custom Processing on Templates.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see Capability
*/
public UpdateStackRequest withCapabilities(String... capabilities) {
if (this.capabilities == null) {
setCapabilities(new com.amazonaws.internal.SdkInternalList(capabilities.length));
}
for (String ele : capabilities) {
this.capabilities.add(ele);
}
return this;
}
/**
*
* In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order
* for CloudFormation to update the stack.
*
*
* -
*
* CAPABILITY_IAM and CAPABILITY_NAMED_IAM
*
*
* Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for
* example, by creating new 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, 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::Role
*
*
* -
*
*
* AWS::IAM::User
*
*
* -
*
*
*
*
* 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 Using CloudFormation
* Macros to Perform Custom Processing on Templates.
*
*
*
*
* @param 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 and CAPABILITY_NAMED_IAM
*
*
* Some stack templates might include resources that can affect permissions in your Amazon Web Services
* account; for example, by creating new 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, 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::Role
*
*
* -
*
*
* AWS::IAM::User
*
*
* -
*
*
*
*
* 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 Using
* CloudFormation Macros to Perform Custom Processing on Templates.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see Capability
*/
public UpdateStackRequest withCapabilities(java.util.Collection capabilities) {
setCapabilities(capabilities);
return this;
}
/**
*
* In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order
* for CloudFormation to update the stack.
*
*
* -
*
* CAPABILITY_IAM and CAPABILITY_NAMED_IAM
*
*
* Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for
* example, by creating new 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, 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::Role
*
*
* -
*
*
* AWS::IAM::User
*
*
* -
*
*
*
*
* 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 Using CloudFormation
* Macros to Perform Custom Processing on Templates.
*
*
*
*
* @param 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 and CAPABILITY_NAMED_IAM
*
*
* Some stack templates might include resources that can affect permissions in your Amazon Web Services
* account; for example, by creating new 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, 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::Role
*
*
* -
*
*
* AWS::IAM::User
*
*
* -
*
*
*
*
* 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 Using
* CloudFormation Macros to Perform Custom Processing on Templates.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see Capability
*/
public UpdateStackRequest withCapabilities(Capability... capabilities) {
com.amazonaws.internal.SdkInternalList capabilitiesCopy = new com.amazonaws.internal.SdkInternalList(capabilities.length);
for (Capability value : capabilities) {
capabilitiesCopy.add(value.toString());
}
if (getCapabilities() == null) {
setCapabilities(capabilitiesCopy);
} else {
getCapabilities().addAll(capabilitiesCopy);
}
return this;
}
/**
*
* 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, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this
* parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access
* with Identity and Access Management.
*
*
* @return 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, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM)
* uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see
*
* Controlling Access with Identity and Access Management.
*/
public java.util.List getResourceTypes() {
if (resourceTypes == null) {
resourceTypes = new com.amazonaws.internal.SdkInternalList();
}
return 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, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this
* parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access
* with Identity and Access Management.
*
*
* @param 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, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM)
* uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see
*
* Controlling Access with Identity and Access Management.
*/
public void setResourceTypes(java.util.Collection resourceTypes) {
if (resourceTypes == null) {
this.resourceTypes = null;
return;
}
this.resourceTypes = new com.amazonaws.internal.SdkInternalList(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, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this
* parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access
* with Identity and Access Management.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setResourceTypes(java.util.Collection)} or {@link #withResourceTypes(java.util.Collection)} if you want
* to override the existing values.
*
*
* @param 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, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM)
* uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see
*
* Controlling Access with Identity and Access Management.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateStackRequest withResourceTypes(String... resourceTypes) {
if (this.resourceTypes == null) {
setResourceTypes(new com.amazonaws.internal.SdkInternalList(resourceTypes.length));
}
for (String ele : resourceTypes) {
this.resourceTypes.add(ele);
}
return this;
}
/**
*
* 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, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this
* parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access
* with Identity and Access Management.
*
*
* @param 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, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM)
* uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see
*
* Controlling Access with Identity and Access Management.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateStackRequest withResourceTypes(java.util.Collection resourceTypes) {
setResourceTypes(resourceTypes);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of an Identity and Access Management (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. As long as 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.
*
*
* @param roleARN
* The Amazon Resource Name (ARN) of an Identity and Access Management (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. As long as 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.
*/
public void setRoleARN(String roleARN) {
this.roleARN = roleARN;
}
/**
*
* The Amazon Resource Name (ARN) of an Identity and Access Management (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. As long as 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.
*
*
* @return The Amazon Resource Name (ARN) of an Identity and Access Management (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. As long as 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.
*/
public String getRoleARN() {
return this.roleARN;
}
/**
*
* The Amazon Resource Name (ARN) of an Identity and Access Management (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. As long as 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.
*
*
* @param roleARN
* The Amazon Resource Name (ARN) of an Identity and Access Management (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. As long as 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateStackRequest withRoleARN(String roleARN) {
setRoleARN(roleARN);
return this;
}
/**
*
* The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the
* specified monitoring period afterwards.
*
*
* @param rollbackConfiguration
* The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for
* the specified monitoring period afterwards.
*/
public void setRollbackConfiguration(RollbackConfiguration rollbackConfiguration) {
this.rollbackConfiguration = rollbackConfiguration;
}
/**
*
* The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the
* specified monitoring period afterwards.
*
*
* @return The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and
* for the specified monitoring period afterwards.
*/
public RollbackConfiguration getRollbackConfiguration() {
return this.rollbackConfiguration;
}
/**
*
* The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the
* specified monitoring period afterwards.
*
*
* @param rollbackConfiguration
* The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for
* the specified monitoring period afterwards.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateStackRequest withRollbackConfiguration(RollbackConfiguration rollbackConfiguration) {
setRollbackConfiguration(rollbackConfiguration);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setStackPolicyBody(String stackPolicyBody) {
this.stackPolicyBody = 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.
*
*
* @return 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.
*/
public String getStackPolicyBody() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateStackRequest withStackPolicyBody(String stackPolicyBody) {
setStackPolicyBody(stackPolicyBody);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setStackPolicyURL(String stackPolicyURL) {
this.stackPolicyURL = 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.
*
*
* @return 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.
*/
public String getStackPolicyURL() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateStackRequest withStackPolicyURL(String stackPolicyURL) {
setStackPolicyURL(stackPolicyURL);
return this;
}
/**
*
* Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation associates with the
* stack. Specify an empty list to remove all notification topics.
*
*
* @return Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation associates with
* the stack. Specify an empty list to remove all notification topics.
*/
public java.util.List getNotificationARNs() {
if (notificationARNs == null) {
notificationARNs = new com.amazonaws.internal.SdkInternalList();
}
return 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.
*
*
* @param 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.
*/
public void setNotificationARNs(java.util.Collection notificationARNs) {
if (notificationARNs == null) {
this.notificationARNs = null;
return;
}
this.notificationARNs = new com.amazonaws.internal.SdkInternalList(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.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setNotificationARNs(java.util.Collection)} or {@link #withNotificationARNs(java.util.Collection)} if you
* want to override the existing values.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateStackRequest withNotificationARNs(String... notificationARNs) {
if (this.notificationARNs == null) {
setNotificationARNs(new com.amazonaws.internal.SdkInternalList(notificationARNs.length));
}
for (String ele : notificationARNs) {
this.notificationARNs.add(ele);
}
return this;
}
/**
*
* Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation associates with the
* stack. Specify an empty list to remove all notification topics.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateStackRequest withNotificationARNs(java.util.Collection notificationARNs) {
setNotificationARNs(notificationARNs);
return this;
}
/**
*
* 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.
*
*
* @return 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.
*/
public java.util.List getTags() {
if (tags == null) {
tags = new com.amazonaws.internal.SdkInternalList();
}
return 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.
*
*
* @param 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.
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new com.amazonaws.internal.SdkInternalList(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.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateStackRequest withTags(Tag... tags) {
if (this.tags == null) {
setTags(new com.amazonaws.internal.SdkInternalList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateStackRequest withTags(java.util.Collection tags) {
setTags(tags);
return this;
}
/**
*
* Preserve the state of previously provisioned resources when an operation fails.
*
*
* Default: False
*
*
* @param disableRollback
* Preserve the state of previously provisioned resources when an operation fails.
*
* Default: False
*/
public void setDisableRollback(Boolean disableRollback) {
this.disableRollback = disableRollback;
}
/**
*
* Preserve the state of previously provisioned resources when an operation fails.
*
*
* Default: False
*
*
* @return Preserve the state of previously provisioned resources when an operation fails.
*
* Default: False
*/
public Boolean getDisableRollback() {
return this.disableRollback;
}
/**
*
* Preserve the state of previously provisioned resources when an operation fails.
*
*
* Default: False
*
*
* @param disableRollback
* Preserve the state of previously provisioned resources when an operation fails.
*
* Default: False
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateStackRequest withDisableRollback(Boolean disableRollback) {
setDisableRollback(disableRollback);
return this;
}
/**
*
* Preserve the state of previously provisioned resources when an operation fails.
*
*
* Default: False
*
*
* @return Preserve the state of previously provisioned resources when an operation fails.
*
* Default: False
*/
public Boolean isDisableRollback() {
return this.disableRollback;
}
/**
*
* 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 retry
* UpdateStack 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 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.
*
*
* @param 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 retry UpdateStack 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 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.
*/
public void setClientRequestToken(String clientRequestToken) {
this.clientRequestToken = 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 retry
* UpdateStack 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 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.
*
*
* @return 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 retry UpdateStack 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 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.
*/
public String getClientRequestToken() {
return this.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 retry
* UpdateStack 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 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.
*
*
* @param 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 retry UpdateStack 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 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateStackRequest withClientRequestToken(String clientRequestToken) {
setClientRequestToken(clientRequestToken);
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getStackName() != null)
sb.append("StackName: ").append(getStackName()).append(",");
if (getTemplateBody() != null)
sb.append("TemplateBody: ").append(getTemplateBody()).append(",");
if (getTemplateURL() != null)
sb.append("TemplateURL: ").append(getTemplateURL()).append(",");
if (getUsePreviousTemplate() != null)
sb.append("UsePreviousTemplate: ").append(getUsePreviousTemplate()).append(",");
if (getStackPolicyDuringUpdateBody() != null)
sb.append("StackPolicyDuringUpdateBody: ").append(getStackPolicyDuringUpdateBody()).append(",");
if (getStackPolicyDuringUpdateURL() != null)
sb.append("StackPolicyDuringUpdateURL: ").append(getStackPolicyDuringUpdateURL()).append(",");
if (getParameters() != null)
sb.append("Parameters: ").append(getParameters()).append(",");
if (getCapabilities() != null)
sb.append("Capabilities: ").append(getCapabilities()).append(",");
if (getResourceTypes() != null)
sb.append("ResourceTypes: ").append(getResourceTypes()).append(",");
if (getRoleARN() != null)
sb.append("RoleARN: ").append(getRoleARN()).append(",");
if (getRollbackConfiguration() != null)
sb.append("RollbackConfiguration: ").append(getRollbackConfiguration()).append(",");
if (getStackPolicyBody() != null)
sb.append("StackPolicyBody: ").append(getStackPolicyBody()).append(",");
if (getStackPolicyURL() != null)
sb.append("StackPolicyURL: ").append(getStackPolicyURL()).append(",");
if (getNotificationARNs() != null)
sb.append("NotificationARNs: ").append(getNotificationARNs()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags()).append(",");
if (getDisableRollback() != null)
sb.append("DisableRollback: ").append(getDisableRollback()).append(",");
if (getClientRequestToken() != null)
sb.append("ClientRequestToken: ").append(getClientRequestToken());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof UpdateStackRequest == false)
return false;
UpdateStackRequest other = (UpdateStackRequest) obj;
if (other.getStackName() == null ^ this.getStackName() == null)
return false;
if (other.getStackName() != null && other.getStackName().equals(this.getStackName()) == false)
return false;
if (other.getTemplateBody() == null ^ this.getTemplateBody() == null)
return false;
if (other.getTemplateBody() != null && other.getTemplateBody().equals(this.getTemplateBody()) == false)
return false;
if (other.getTemplateURL() == null ^ this.getTemplateURL() == null)
return false;
if (other.getTemplateURL() != null && other.getTemplateURL().equals(this.getTemplateURL()) == false)
return false;
if (other.getUsePreviousTemplate() == null ^ this.getUsePreviousTemplate() == null)
return false;
if (other.getUsePreviousTemplate() != null && other.getUsePreviousTemplate().equals(this.getUsePreviousTemplate()) == false)
return false;
if (other.getStackPolicyDuringUpdateBody() == null ^ this.getStackPolicyDuringUpdateBody() == null)
return false;
if (other.getStackPolicyDuringUpdateBody() != null && other.getStackPolicyDuringUpdateBody().equals(this.getStackPolicyDuringUpdateBody()) == false)
return false;
if (other.getStackPolicyDuringUpdateURL() == null ^ this.getStackPolicyDuringUpdateURL() == null)
return false;
if (other.getStackPolicyDuringUpdateURL() != null && other.getStackPolicyDuringUpdateURL().equals(this.getStackPolicyDuringUpdateURL()) == false)
return false;
if (other.getParameters() == null ^ this.getParameters() == null)
return false;
if (other.getParameters() != null && other.getParameters().equals(this.getParameters()) == false)
return false;
if (other.getCapabilities() == null ^ this.getCapabilities() == null)
return false;
if (other.getCapabilities() != null && other.getCapabilities().equals(this.getCapabilities()) == false)
return false;
if (other.getResourceTypes() == null ^ this.getResourceTypes() == null)
return false;
if (other.getResourceTypes() != null && other.getResourceTypes().equals(this.getResourceTypes()) == false)
return false;
if (other.getRoleARN() == null ^ this.getRoleARN() == null)
return false;
if (other.getRoleARN() != null && other.getRoleARN().equals(this.getRoleARN()) == false)
return false;
if (other.getRollbackConfiguration() == null ^ this.getRollbackConfiguration() == null)
return false;
if (other.getRollbackConfiguration() != null && other.getRollbackConfiguration().equals(this.getRollbackConfiguration()) == false)
return false;
if (other.getStackPolicyBody() == null ^ this.getStackPolicyBody() == null)
return false;
if (other.getStackPolicyBody() != null && other.getStackPolicyBody().equals(this.getStackPolicyBody()) == false)
return false;
if (other.getStackPolicyURL() == null ^ this.getStackPolicyURL() == null)
return false;
if (other.getStackPolicyURL() != null && other.getStackPolicyURL().equals(this.getStackPolicyURL()) == false)
return false;
if (other.getNotificationARNs() == null ^ this.getNotificationARNs() == null)
return false;
if (other.getNotificationARNs() != null && other.getNotificationARNs().equals(this.getNotificationARNs()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
if (other.getDisableRollback() == null ^ this.getDisableRollback() == null)
return false;
if (other.getDisableRollback() != null && other.getDisableRollback().equals(this.getDisableRollback()) == false)
return false;
if (other.getClientRequestToken() == null ^ this.getClientRequestToken() == null)
return false;
if (other.getClientRequestToken() != null && other.getClientRequestToken().equals(this.getClientRequestToken()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getStackName() == null) ? 0 : getStackName().hashCode());
hashCode = prime * hashCode + ((getTemplateBody() == null) ? 0 : getTemplateBody().hashCode());
hashCode = prime * hashCode + ((getTemplateURL() == null) ? 0 : getTemplateURL().hashCode());
hashCode = prime * hashCode + ((getUsePreviousTemplate() == null) ? 0 : getUsePreviousTemplate().hashCode());
hashCode = prime * hashCode + ((getStackPolicyDuringUpdateBody() == null) ? 0 : getStackPolicyDuringUpdateBody().hashCode());
hashCode = prime * hashCode + ((getStackPolicyDuringUpdateURL() == null) ? 0 : getStackPolicyDuringUpdateURL().hashCode());
hashCode = prime * hashCode + ((getParameters() == null) ? 0 : getParameters().hashCode());
hashCode = prime * hashCode + ((getCapabilities() == null) ? 0 : getCapabilities().hashCode());
hashCode = prime * hashCode + ((getResourceTypes() == null) ? 0 : getResourceTypes().hashCode());
hashCode = prime * hashCode + ((getRoleARN() == null) ? 0 : getRoleARN().hashCode());
hashCode = prime * hashCode + ((getRollbackConfiguration() == null) ? 0 : getRollbackConfiguration().hashCode());
hashCode = prime * hashCode + ((getStackPolicyBody() == null) ? 0 : getStackPolicyBody().hashCode());
hashCode = prime * hashCode + ((getStackPolicyURL() == null) ? 0 : getStackPolicyURL().hashCode());
hashCode = prime * hashCode + ((getNotificationARNs() == null) ? 0 : getNotificationARNs().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
hashCode = prime * hashCode + ((getDisableRollback() == null) ? 0 : getDisableRollback().hashCode());
hashCode = prime * hashCode + ((getClientRequestToken() == null) ? 0 : getClientRequestToken().hashCode());
return hashCode;
}
@Override
public UpdateStackRequest clone() {
return (UpdateStackRequest) super.clone();
}
}