com.amazonaws.services.cloudformation.model.CreateChangeSetRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-cloudformation Show documentation
/*
* Copyright 2018-2023 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 the CreateChangeSet action.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateChangeSetRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name or the unique ID of the stack for which you are creating a change set. CloudFormation generates the
* change set by comparing this stack's information with the information that you submit, such as a modified
* template or different parameter input values.
*
*/
private String stackName;
/**
*
* A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length
* of 51,200 bytes. CloudFormation generates the change set by comparing this template with the template of the
* stack that you specified.
*
*
* Conditional: You must specify only TemplateBody or TemplateURL.
*
*/
private String templateBody;
/**
*
* The location of the file that contains the revised template. The URL must point to a template (max size: 460,800
* bytes) that's located in an Amazon S3 bucket or a Systems Manager document. CloudFormation generates the change
* set by comparing this template with the stack that you specified.
*
*
* Conditional: You must specify only TemplateBody or TemplateURL.
*
*/
private String templateURL;
/**
*
* Whether to reuse the template that's associated with the stack to create the change set.
*
*/
private Boolean usePreviousTemplate;
/**
*
* A list of Parameter structures that specify input parameters for the change set. 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 create 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 suggest 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 creating the stack. If your stack template contains one or more macros, and you choose to
* create a stack directly from the processed template, without first reviewing the resulting changes in a change
* set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
*
*
*
* This capacity doesn't apply to creating change sets, and specifying it when creating change sets has no effect.
*
*
* If you want to create a stack from a stack template that contains macros and nested stacks, you must
* create or update the stack directly from the template using the CreateStack or UpdateStack action,
* and specifying this capability.
*
*
*
* For more information about macros, see Using CloudFormation
* macros to perform custom processing on templates.
*
*
*
*
*
* Only one of the Capabilities and ResourceType parameters can be specified.
*
*
*/
private com.amazonaws.internal.SdkInternalList capabilities;
/**
*
* The template resource types that you have permissions to work with if you execute this change set, such as
* AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.
*
*
* If the list of resource types doesn't include a resource type 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 condition keys in IAM policies for CloudFormation. For more information, see Controlling access
* with Identity and Access Management in the CloudFormation User Guide.
*
*
*
* Only one of the Capabilities and ResourceType parameters can be specified.
*
*
*/
private com.amazonaws.internal.SdkInternalList resourceTypes;
/**
*
* The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes when
* executing the change set. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation
* uses this role for all future operations on the stack. Provided that users have permission to operate on the
* stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role
* grants least permission.
*
*
* 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;
/**
*
* The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that CloudFormation
* associates with the stack. To remove all associated notification topics, specify an empty list.
*
*/
private com.amazonaws.internal.SdkInternalList notificationARNs;
/**
*
* Key-value pairs to associate with this stack. CloudFormation also propagates these tags to resources in the
* stack. You can specify a maximum of 50 tags.
*
*/
private com.amazonaws.internal.SdkInternalList tags;
/**
*
* The name of the change set. The name must be unique among all change sets that are associated with the specified
* stack.
*
*
* A change set name can contain only alphanumeric, case sensitive characters, and hyphens. It must start with an
* alphabetical character and can't exceed 128 characters.
*
*/
private String changeSetName;
/**
*
* A unique identifier for this CreateChangeSet request. Specify this token if you plan to retry
* requests so that CloudFormation knows that you're not attempting to create another change set with the same name.
* You might retry CreateChangeSet requests to ensure that CloudFormation successfully received them.
*
*/
private String clientToken;
/**
*
* A description to help you identify this change set.
*
*/
private String description;
/**
*
* The type of change set operation. To create a change set for a new stack, specify CREATE. To create
* a change set for an existing stack, specify UPDATE. To create a change set for an import operation,
* specify IMPORT.
*
*
* If you create a change set for a new stack, CloudFormation creates a stack with a unique stack ID, but no
* template or resources. The stack will be in the REVIEW_IN_PROGRESS state until you execute the change set.
*
*
* By default, CloudFormation specifies UPDATE. You can't use the UPDATE type to create a
* change set for a new stack or the CREATE type to create a change set for an existing stack.
*
*/
private String changeSetType;
/**
*
* The resources to import into your stack.
*
*/
private com.amazonaws.internal.SdkInternalList resourcesToImport;
/**
*
* Creates a change set for the all nested stacks specified in the template. The default behavior of this action is
* set to False. To include nested sets in a change set, specify True.
*
*/
private Boolean includeNestedStacks;
/**
*
* Determines what action will be taken if stack creation fails. If this parameter is specified, the
* DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these values:
*
*
* -
*
* DELETE - Deletes the change set if the stack creation fails. This is only valid when the
* ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the
* status of the stack is DELETE_FAILED.
*
*
* -
*
* DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying
* true for the DisableRollback parameter to the ExecuteChangeSet API operation.
*
*
* -
*
* ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying
* false for the DisableRollback parameter to the ExecuteChangeSet API operation.
*
*
*
*
* For nested stacks, when the OnStackFailure parameter is set to DELETE for the change
* set for the parent stack, any failure in a child stack will cause the parent stack creation to fail and all
* stacks to be deleted.
*
*/
private String onStackFailure;
/**
*
* Indicates if the stack set imports resources that already exist.
*
*
*
* This parameter can only import resources that have custom names in templates. For more information, see name type in
* the CloudFormation User Guide. To import resources that do not accept custom names, such as EC2 instances,
* use the resource import feature instead. For more information, see Bringing existing
* resources into CloudFormation management in the CloudFormation User Guide.
*
*
*/
private Boolean importExistingResources;
/**
*
* The name or the unique ID of the stack for which you are creating a change set. CloudFormation generates the
* change set by comparing this stack's information with the information that you submit, such as a modified
* template or different parameter input values.
*
*
* @param stackName
* The name or the unique ID of the stack for which you are creating a change set. CloudFormation generates
* the change set by comparing this stack's information with the information that you submit, such as a
* modified template or different parameter input values.
*/
public void setStackName(String stackName) {
this.stackName = stackName;
}
/**
*
* The name or the unique ID of the stack for which you are creating a change set. CloudFormation generates the
* change set by comparing this stack's information with the information that you submit, such as a modified
* template or different parameter input values.
*
*
* @return The name or the unique ID of the stack for which you are creating a change set. CloudFormation generates
* the change set by comparing this stack's information with the information that you submit, such as a
* modified template or different parameter input values.
*/
public String getStackName() {
return this.stackName;
}
/**
*
* The name or the unique ID of the stack for which you are creating a change set. CloudFormation generates the
* change set by comparing this stack's information with the information that you submit, such as a modified
* template or different parameter input values.
*
*
* @param stackName
* The name or the unique ID of the stack for which you are creating a change set. CloudFormation generates
* the change set by comparing this stack's information with the information that you submit, such as a
* modified template or different parameter input values.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateChangeSetRequest withStackName(String stackName) {
setStackName(stackName);
return this;
}
/**
*
* A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length
* of 51,200 bytes. CloudFormation generates the change set by comparing this template with the template of the
* stack that you specified.
*
*
* Conditional: You must specify only TemplateBody or TemplateURL.
*
*
* @param templateBody
* A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum
* length of 51,200 bytes. CloudFormation generates the change set by comparing this template with the
* template of the stack that you specified.
*
* Conditional: You must specify only TemplateBody or TemplateURL.
*/
public void setTemplateBody(String templateBody) {
this.templateBody = templateBody;
}
/**
*
* A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length
* of 51,200 bytes. CloudFormation generates the change set by comparing this template with the template of the
* stack that you specified.
*
*
* Conditional: You must specify only TemplateBody or TemplateURL.
*
*
* @return A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum
* length of 51,200 bytes. CloudFormation generates the change set by comparing this template with the
* template of the stack that you specified.
*
* Conditional: You must specify only TemplateBody or TemplateURL.
*/
public String getTemplateBody() {
return this.templateBody;
}
/**
*
* A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length
* of 51,200 bytes. CloudFormation generates the change set by comparing this template with the template of the
* stack that you specified.
*
*
* Conditional: You must specify only TemplateBody or TemplateURL.
*
*
* @param templateBody
* A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum
* length of 51,200 bytes. CloudFormation generates the change set by comparing this template with the
* template of the stack that you specified.
*
* Conditional: You must specify only TemplateBody or TemplateURL.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateChangeSetRequest withTemplateBody(String templateBody) {
setTemplateBody(templateBody);
return this;
}
/**
*
* The location of the file that contains the revised template. The URL must point to a template (max size: 460,800
* bytes) that's located in an Amazon S3 bucket or a Systems Manager document. CloudFormation generates the change
* set by comparing this template with the stack that you specified.
*
*
* Conditional: You must specify only TemplateBody or TemplateURL.
*
*
* @param templateURL
* The location of the file that contains the revised template. The URL must point to a template (max size:
* 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. CloudFormation
* generates the change set by comparing this template with the stack that you specified.
*
* Conditional: You must specify only TemplateBody or TemplateURL.
*/
public void setTemplateURL(String templateURL) {
this.templateURL = templateURL;
}
/**
*
* The location of the file that contains the revised template. The URL must point to a template (max size: 460,800
* bytes) that's located in an Amazon S3 bucket or a Systems Manager document. CloudFormation generates the change
* set by comparing this template with the stack that you specified.
*
*
* Conditional: You must specify only TemplateBody or TemplateURL.
*
*
* @return The location of the file that contains the revised template. The URL must point to a template (max size:
* 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. CloudFormation
* generates the change set by comparing this template with the stack that you specified.
*
* Conditional: You must specify only TemplateBody or TemplateURL.
*/
public String getTemplateURL() {
return this.templateURL;
}
/**
*
* The location of the file that contains the revised template. The URL must point to a template (max size: 460,800
* bytes) that's located in an Amazon S3 bucket or a Systems Manager document. CloudFormation generates the change
* set by comparing this template with the stack that you specified.
*
*
* Conditional: You must specify only TemplateBody or TemplateURL.
*
*
* @param templateURL
* The location of the file that contains the revised template. The URL must point to a template (max size:
* 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. CloudFormation
* generates the change set by comparing this template with the stack that you specified.
*
* Conditional: You must specify only TemplateBody or TemplateURL.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateChangeSetRequest withTemplateURL(String templateURL) {
setTemplateURL(templateURL);
return this;
}
/**
*
* Whether to reuse the template that's associated with the stack to create the change set.
*
*
* @param usePreviousTemplate
* Whether to reuse the template that's associated with the stack to create the change set.
*/
public void setUsePreviousTemplate(Boolean usePreviousTemplate) {
this.usePreviousTemplate = usePreviousTemplate;
}
/**
*
* Whether to reuse the template that's associated with the stack to create the change set.
*
*
* @return Whether to reuse the template that's associated with the stack to create the change set.
*/
public Boolean getUsePreviousTemplate() {
return this.usePreviousTemplate;
}
/**
*
* Whether to reuse the template that's associated with the stack to create the change set.
*
*
* @param usePreviousTemplate
* Whether to reuse the template that's associated with the stack to create the change set.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateChangeSetRequest withUsePreviousTemplate(Boolean usePreviousTemplate) {
setUsePreviousTemplate(usePreviousTemplate);
return this;
}
/**
*
* Whether to reuse the template that's associated with the stack to create the change set.
*
*
* @return Whether to reuse the template that's associated with the stack to create the change set.
*/
public Boolean isUsePreviousTemplate() {
return this.usePreviousTemplate;
}
/**
*
* A list of Parameter structures that specify input parameters for the change set. For more
* information, see the Parameter data type.
*
*
* @return A list of Parameter structures that specify input parameters for the change set. 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 change set. For more
* information, see the Parameter data type.
*
*
* @param parameters
* A list of Parameter structures that specify input parameters for the change set. 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 change set. 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 change set. For more
* information, see the Parameter data type.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateChangeSetRequest 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 change set. For more
* information, see the Parameter data type.
*
*
* @param parameters
* A list of Parameter structures that specify input parameters for the change set. For more
* information, see the Parameter data type.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateChangeSetRequest 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 create 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 suggest 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 creating the stack. If your stack template contains one or more macros, and you choose to
* create a stack directly from the processed template, without first reviewing the resulting changes in a change
* set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
*
*
*
* This capacity doesn't apply to creating change sets, and specifying it when creating change sets has no effect.
*
*
* If you want to create a stack from a stack template that contains macros and nested stacks, you must
* create or update the stack directly from the template using the CreateStack or UpdateStack action,
* and specifying this capability.
*
*
*
* For more information about macros, see Using CloudFormation
* macros to perform custom processing on templates.
*
*
*
*
*
* Only one of the Capabilities and ResourceType parameters can be specified.
*
*
*
* @return In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in
* order for CloudFormation to create 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 suggest 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 creating the stack. If your stack template contains
* one or more macros, and you choose to create a stack directly from the processed template, without first
* reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the
* AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
*
*
*
* This capacity doesn't apply to creating change sets, and specifying it when creating change sets has no
* effect.
*
*
* If you want to create a stack from a stack template that contains macros and nested stacks, you
* must create or update the stack directly from the template using the CreateStack or
* UpdateStack action, and specifying this capability.
*
*
*
* For more information about macros, see Using
* CloudFormation macros to perform custom processing on templates.
*
*
*
*
*
* Only one of the Capabilities and ResourceType parameters can be specified.
*
* @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 create 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 suggest 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 creating the stack. If your stack template contains one or more macros, and you choose to
* create a stack directly from the processed template, without first reviewing the resulting changes in a change
* set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
*
*
*
* This capacity doesn't apply to creating change sets, and specifying it when creating change sets has no effect.
*
*
* If you want to create a stack from a stack template that contains macros and nested stacks, you must
* create or update the stack directly from the template using the CreateStack or UpdateStack action,
* and specifying this capability.
*
*
*
* For more information about macros, see Using CloudFormation
* macros to perform custom processing on templates.
*
*
*
*
*
* Only one of the Capabilities and ResourceType parameters can be specified.
*
*
*
* @param capabilities
* In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in
* order for CloudFormation to create 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 suggest 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 creating the stack. If your stack template contains
* one or more macros, and you choose to create a stack directly from the processed template, without first
* reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the
* AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
*
*
*
* This capacity doesn't apply to creating change sets, and specifying it when creating change sets has no
* effect.
*
*
* If you want to create a stack from a stack template that contains macros and nested stacks, you
* must create or update the stack directly from the template using the CreateStack or
* UpdateStack action, and specifying this capability.
*
*
*
* For more information about macros, see Using
* CloudFormation macros to perform custom processing on templates.
*
*
*
*
*
* Only one of the Capabilities and ResourceType parameters can be specified.
*
* @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 create 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 suggest 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 creating the stack. If your stack template contains one or more macros, and you choose to
* create a stack directly from the processed template, without first reviewing the resulting changes in a change
* set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
*
*
*
* This capacity doesn't apply to creating change sets, and specifying it when creating change sets has no effect.
*
*
* If you want to create a stack from a stack template that contains macros and nested stacks, you must
* create or update the stack directly from the template using the CreateStack or UpdateStack action,
* and specifying this capability.
*
*
*
* For more information about macros, see Using CloudFormation
* macros to perform custom processing on templates.
*
*
*
*
*
* Only one of the Capabilities and ResourceType parameters can be specified.
*
*
*
* 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 create 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 suggest 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 creating the stack. If your stack template contains
* one or more macros, and you choose to create a stack directly from the processed template, without first
* reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the
* AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
*
*
*
* This capacity doesn't apply to creating change sets, and specifying it when creating change sets has no
* effect.
*
*
* If you want to create a stack from a stack template that contains macros and nested stacks, you
* must create or update the stack directly from the template using the CreateStack or
* UpdateStack action, and specifying this capability.
*
*
*
* For more information about macros, see Using
* CloudFormation macros to perform custom processing on templates.
*
*
*
*
*
* Only one of the Capabilities and ResourceType parameters can be specified.
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see Capability
*/
public CreateChangeSetRequest 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 create 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 suggest 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 creating the stack. If your stack template contains one or more macros, and you choose to
* create a stack directly from the processed template, without first reviewing the resulting changes in a change
* set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
*
*
*
* This capacity doesn't apply to creating change sets, and specifying it when creating change sets has no effect.
*
*
* If you want to create a stack from a stack template that contains macros and nested stacks, you must
* create or update the stack directly from the template using the CreateStack or UpdateStack action,
* and specifying this capability.
*
*
*
* For more information about macros, see Using CloudFormation
* macros to perform custom processing on templates.
*
*
*
*
*
* Only one of the Capabilities and ResourceType parameters can be specified.
*
*
*
* @param capabilities
* In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in
* order for CloudFormation to create 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 suggest 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 creating the stack. If your stack template contains
* one or more macros, and you choose to create a stack directly from the processed template, without first
* reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the
* AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
*
*
*
* This capacity doesn't apply to creating change sets, and specifying it when creating change sets has no
* effect.
*
*
* If you want to create a stack from a stack template that contains macros and nested stacks, you
* must create or update the stack directly from the template using the CreateStack or
* UpdateStack action, and specifying this capability.
*
*
*
* For more information about macros, see Using
* CloudFormation macros to perform custom processing on templates.
*
*
*
*
*
* Only one of the Capabilities and ResourceType parameters can be specified.
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see Capability
*/
public CreateChangeSetRequest 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 create 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 suggest 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 creating the stack. If your stack template contains one or more macros, and you choose to
* create a stack directly from the processed template, without first reviewing the resulting changes in a change
* set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
*
*
*
* This capacity doesn't apply to creating change sets, and specifying it when creating change sets has no effect.
*
*
* If you want to create a stack from a stack template that contains macros and nested stacks, you must
* create or update the stack directly from the template using the CreateStack or UpdateStack action,
* and specifying this capability.
*
*
*
* For more information about macros, see Using CloudFormation
* macros to perform custom processing on templates.
*
*
*
*
*
* Only one of the Capabilities and ResourceType parameters can be specified.
*
*
*
* @param capabilities
* In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in
* order for CloudFormation to create 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 suggest 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 creating the stack. If your stack template contains
* one or more macros, and you choose to create a stack directly from the processed template, without first
* reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the
* AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
*
*
*
* This capacity doesn't apply to creating change sets, and specifying it when creating change sets has no
* effect.
*
*
* If you want to create a stack from a stack template that contains macros and nested stacks, you
* must create or update the stack directly from the template using the CreateStack or
* UpdateStack action, and specifying this capability.
*
*
*
* For more information about macros, see Using
* CloudFormation macros to perform custom processing on templates.
*
*
*
*
*
* Only one of the Capabilities and ResourceType parameters can be specified.
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see Capability
*/
public CreateChangeSetRequest 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 if you execute this change set, such as
* AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.
*
*
* If the list of resource types doesn't include a resource type 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 condition keys in IAM policies for CloudFormation. For more information, see Controlling access
* with Identity and Access Management in the CloudFormation User Guide.
*
*
*
* Only one of the Capabilities and ResourceType parameters can be specified.
*
*
*
* @return The template resource types that you have permissions to work with if you execute this change set, such
* as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance
* .
*
* If the list of resource types doesn't include a resource type 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 condition keys in IAM policies for CloudFormation. For more
* information, see Controlling
* access with Identity and Access Management in the CloudFormation User Guide.
*
*
*
* Only one of the Capabilities and ResourceType parameters can be specified.
*
*/
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 if you execute this change set, such as
* AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.
*
*
* If the list of resource types doesn't include a resource type 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 condition keys in IAM policies for CloudFormation. For more information, see Controlling access
* with Identity and Access Management in the CloudFormation User Guide.
*
*
*
* Only one of the Capabilities and ResourceType parameters can be specified.
*
*
*
* @param resourceTypes
* The template resource types that you have permissions to work with if you execute this change set, such as
* AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.
*
* If the list of resource types doesn't include a resource type 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 condition keys in IAM policies for CloudFormation. For more information, see
*
* Controlling access with Identity and Access Management in the CloudFormation User Guide.
*
*
*
* Only one of the Capabilities and ResourceType parameters can be specified.
*
*/
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 if you execute this change set, such as
* AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.
*
*
* If the list of resource types doesn't include a resource type 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 condition keys in IAM policies for CloudFormation. For more information, see Controlling access
* with Identity and Access Management in the CloudFormation User Guide.
*
*
*
* Only one of the Capabilities and ResourceType parameters can be specified.
*
*
*
* 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 if you execute this change set, such as
* AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.
*
* If the list of resource types doesn't include a resource type 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 condition keys in IAM policies for CloudFormation. For more information, see
*
* Controlling access with Identity and Access Management in the CloudFormation User Guide.
*
*
*
* Only one of the Capabilities and ResourceType parameters can be specified.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateChangeSetRequest 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 if you execute this change set, such as
* AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.
*
*
* If the list of resource types doesn't include a resource type 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 condition keys in IAM policies for CloudFormation. For more information, see Controlling access
* with Identity and Access Management in the CloudFormation User Guide.
*
*
*
* Only one of the Capabilities and ResourceType parameters can be specified.
*
*
*
* @param resourceTypes
* The template resource types that you have permissions to work with if you execute this change set, such as
* AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.
*
* If the list of resource types doesn't include a resource type 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 condition keys in IAM policies for CloudFormation. For more information, see
*
* Controlling access with Identity and Access Management in the CloudFormation User Guide.
*
*
*
* Only one of the Capabilities and ResourceType parameters can be specified.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateChangeSetRequest 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 when
* executing the change set. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation
* uses this role for all future operations on the stack. Provided that users have permission to operate on the
* stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role
* grants least permission.
*
*
* 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
* when executing the change set. CloudFormation uses the role's credentials to make calls on your behalf.
* CloudFormation uses this role for all future operations on the stack. Provided that users have permission
* to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it.
* Ensure that the role grants least permission.
*
* 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 when
* executing the change set. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation
* uses this role for all future operations on the stack. Provided that users have permission to operate on the
* stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role
* grants least permission.
*
*
* 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 when executing the change set. CloudFormation uses the role's credentials to make calls on your
* behalf. CloudFormation uses this role for all future operations on the stack. Provided that users have
* permission to operate on the stack, CloudFormation uses this role even if the users don't have permission
* to pass it. Ensure that the role grants least permission.
*
* 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 when
* executing the change set. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation
* uses this role for all future operations on the stack. Provided that users have permission to operate on the
* stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role
* grants least permission.
*
*
* 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
* when executing the change set. CloudFormation uses the role's credentials to make calls on your behalf.
* CloudFormation uses this role for all future operations on the stack. Provided that users have permission
* to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it.
* Ensure that the role grants least permission.
*
* 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 CreateChangeSetRequest 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 CreateChangeSetRequest withRollbackConfiguration(RollbackConfiguration rollbackConfiguration) {
setRollbackConfiguration(rollbackConfiguration);
return this;
}
/**
*
* The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that CloudFormation
* associates with the stack. To remove all associated notification topics, specify an empty list.
*
*
* @return The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that
* CloudFormation associates with the stack. To remove all associated notification topics, specify an empty
* list.
*/
public java.util.List getNotificationARNs() {
if (notificationARNs == null) {
notificationARNs = new com.amazonaws.internal.SdkInternalList();
}
return notificationARNs;
}
/**
*
* The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that CloudFormation
* associates with the stack. To remove all associated notification topics, specify an empty list.
*
*
* @param notificationARNs
* The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that
* CloudFormation associates with the stack. To remove all associated notification topics, specify an empty
* list.
*/
public void setNotificationARNs(java.util.Collection notificationARNs) {
if (notificationARNs == null) {
this.notificationARNs = null;
return;
}
this.notificationARNs = new com.amazonaws.internal.SdkInternalList(notificationARNs);
}
/**
*
* The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that CloudFormation
* associates with the stack. To remove all associated notification topics, specify an empty list.
*
*
* 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
* The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that
* CloudFormation associates with the stack. To remove all associated notification topics, specify an empty
* list.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateChangeSetRequest 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;
}
/**
*
* The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that CloudFormation
* associates with the stack. To remove all associated notification topics, specify an empty list.
*
*
* @param notificationARNs
* The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that
* CloudFormation associates with the stack. To remove all associated notification topics, specify an empty
* list.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateChangeSetRequest withNotificationARNs(java.util.Collection notificationARNs) {
setNotificationARNs(notificationARNs);
return this;
}
/**
*
* Key-value pairs to associate with this stack. CloudFormation also propagates these tags to resources in the
* stack. You can specify a maximum of 50 tags.
*
*
* @return Key-value pairs to associate with this stack. CloudFormation also propagates these tags to resources in
* the stack. You can specify a maximum of 50 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 resources in the
* stack. You can specify a maximum of 50 tags.
*
*
* @param tags
* Key-value pairs to associate with this stack. CloudFormation also propagates these tags to resources in
* the stack. You can specify a maximum of 50 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 resources in the
* stack. You can specify a maximum of 50 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 resources in
* the stack. You can specify a maximum of 50 tags.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateChangeSetRequest 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 resources in the
* stack. You can specify a maximum of 50 tags.
*
*
* @param tags
* Key-value pairs to associate with this stack. CloudFormation also propagates these tags to resources in
* the stack. You can specify a maximum of 50 tags.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateChangeSetRequest withTags(java.util.Collection tags) {
setTags(tags);
return this;
}
/**
*
* The name of the change set. The name must be unique among all change sets that are associated with the specified
* stack.
*
*
* A change set name can contain only alphanumeric, case sensitive characters, and hyphens. It must start with an
* alphabetical character and can't exceed 128 characters.
*
*
* @param changeSetName
* The name of the change set. The name must be unique among all change sets that are associated with the
* specified stack.
*
* A change set name can contain only alphanumeric, case sensitive characters, and hyphens. It must start
* with an alphabetical character and can't exceed 128 characters.
*/
public void setChangeSetName(String changeSetName) {
this.changeSetName = changeSetName;
}
/**
*
* The name of the change set. The name must be unique among all change sets that are associated with the specified
* stack.
*
*
* A change set name can contain only alphanumeric, case sensitive characters, and hyphens. It must start with an
* alphabetical character and can't exceed 128 characters.
*
*
* @return The name of the change set. The name must be unique among all change sets that are associated with the
* specified stack.
*
* A change set name can contain only alphanumeric, case sensitive characters, and hyphens. It must start
* with an alphabetical character and can't exceed 128 characters.
*/
public String getChangeSetName() {
return this.changeSetName;
}
/**
*
* The name of the change set. The name must be unique among all change sets that are associated with the specified
* stack.
*
*
* A change set name can contain only alphanumeric, case sensitive characters, and hyphens. It must start with an
* alphabetical character and can't exceed 128 characters.
*
*
* @param changeSetName
* The name of the change set. The name must be unique among all change sets that are associated with the
* specified stack.
*
* A change set name can contain only alphanumeric, case sensitive characters, and hyphens. It must start
* with an alphabetical character and can't exceed 128 characters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateChangeSetRequest withChangeSetName(String changeSetName) {
setChangeSetName(changeSetName);
return this;
}
/**
*
* A unique identifier for this CreateChangeSet request. Specify this token if you plan to retry
* requests so that CloudFormation knows that you're not attempting to create another change set with the same name.
* You might retry CreateChangeSet requests to ensure that CloudFormation successfully received them.
*
*
* @param clientToken
* A unique identifier for this CreateChangeSet request. Specify this token if you plan to retry
* requests so that CloudFormation knows that you're not attempting to create another change set with the
* same name. You might retry CreateChangeSet requests to ensure that CloudFormation
* successfully received them.
*/
public void setClientToken(String clientToken) {
this.clientToken = clientToken;
}
/**
*
* A unique identifier for this CreateChangeSet request. Specify this token if you plan to retry
* requests so that CloudFormation knows that you're not attempting to create another change set with the same name.
* You might retry CreateChangeSet requests to ensure that CloudFormation successfully received them.
*
*
* @return A unique identifier for this CreateChangeSet request. Specify this token if you plan to
* retry requests so that CloudFormation knows that you're not attempting to create another change set with
* the same name. You might retry CreateChangeSet requests to ensure that CloudFormation
* successfully received them.
*/
public String getClientToken() {
return this.clientToken;
}
/**
*
* A unique identifier for this CreateChangeSet request. Specify this token if you plan to retry
* requests so that CloudFormation knows that you're not attempting to create another change set with the same name.
* You might retry CreateChangeSet requests to ensure that CloudFormation successfully received them.
*
*
* @param clientToken
* A unique identifier for this CreateChangeSet request. Specify this token if you plan to retry
* requests so that CloudFormation knows that you're not attempting to create another change set with the
* same name. You might retry CreateChangeSet requests to ensure that CloudFormation
* successfully received them.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateChangeSetRequest withClientToken(String clientToken) {
setClientToken(clientToken);
return this;
}
/**
*
* A description to help you identify this change set.
*
*
* @param description
* A description to help you identify this change set.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* A description to help you identify this change set.
*
*
* @return A description to help you identify this change set.
*/
public String getDescription() {
return this.description;
}
/**
*
* A description to help you identify this change set.
*
*
* @param description
* A description to help you identify this change set.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateChangeSetRequest withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* The type of change set operation. To create a change set for a new stack, specify CREATE. To create
* a change set for an existing stack, specify UPDATE. To create a change set for an import operation,
* specify IMPORT.
*
*
* If you create a change set for a new stack, CloudFormation creates a stack with a unique stack ID, but no
* template or resources. The stack will be in the REVIEW_IN_PROGRESS state until you execute the change set.
*
*
* By default, CloudFormation specifies UPDATE. You can't use the UPDATE type to create a
* change set for a new stack or the CREATE type to create a change set for an existing stack.
*
*
* @param changeSetType
* The type of change set operation. To create a change set for a new stack, specify CREATE. To
* create a change set for an existing stack, specify UPDATE. To create a change set for an
* import operation, specify IMPORT.
*
* If you create a change set for a new stack, CloudFormation creates a stack with a unique stack ID, but no
* template or resources. The stack will be in the REVIEW_IN_PROGRESS state until you execute the change set.
*
*
* By default, CloudFormation specifies UPDATE. You can't use the UPDATE type to
* create a change set for a new stack or the CREATE type to create a change set for an existing
* stack.
* @see ChangeSetType
*/
public void setChangeSetType(String changeSetType) {
this.changeSetType = changeSetType;
}
/**
*
* The type of change set operation. To create a change set for a new stack, specify CREATE. To create
* a change set for an existing stack, specify UPDATE. To create a change set for an import operation,
* specify IMPORT.
*
*
* If you create a change set for a new stack, CloudFormation creates a stack with a unique stack ID, but no
* template or resources. The stack will be in the REVIEW_IN_PROGRESS state until you execute the change set.
*
*
* By default, CloudFormation specifies UPDATE. You can't use the UPDATE type to create a
* change set for a new stack or the CREATE type to create a change set for an existing stack.
*
*
* @return The type of change set operation. To create a change set for a new stack, specify CREATE. To
* create a change set for an existing stack, specify UPDATE. To create a change set for an
* import operation, specify IMPORT.
*
* If you create a change set for a new stack, CloudFormation creates a stack with a unique stack ID, but no
* template or resources. The stack will be in the REVIEW_IN_PROGRESS state until you execute the change set.
*
*
* By default, CloudFormation specifies UPDATE. You can't use the UPDATE type to
* create a change set for a new stack or the CREATE type to create a change set for an
* existing stack.
* @see ChangeSetType
*/
public String getChangeSetType() {
return this.changeSetType;
}
/**
*
* The type of change set operation. To create a change set for a new stack, specify CREATE. To create
* a change set for an existing stack, specify UPDATE. To create a change set for an import operation,
* specify IMPORT.
*
*
* If you create a change set for a new stack, CloudFormation creates a stack with a unique stack ID, but no
* template or resources. The stack will be in the REVIEW_IN_PROGRESS state until you execute the change set.
*
*
* By default, CloudFormation specifies UPDATE. You can't use the UPDATE type to create a
* change set for a new stack or the CREATE type to create a change set for an existing stack.
*
*
* @param changeSetType
* The type of change set operation. To create a change set for a new stack, specify CREATE. To
* create a change set for an existing stack, specify UPDATE. To create a change set for an
* import operation, specify IMPORT.
*
* If you create a change set for a new stack, CloudFormation creates a stack with a unique stack ID, but no
* template or resources. The stack will be in the REVIEW_IN_PROGRESS state until you execute the change set.
*
*
* By default, CloudFormation specifies UPDATE. You can't use the UPDATE type to
* create a change set for a new stack or the CREATE type to create a change set for an existing
* stack.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ChangeSetType
*/
public CreateChangeSetRequest withChangeSetType(String changeSetType) {
setChangeSetType(changeSetType);
return this;
}
/**
*
* The type of change set operation. To create a change set for a new stack, specify CREATE. To create
* a change set for an existing stack, specify UPDATE. To create a change set for an import operation,
* specify IMPORT.
*
*
* If you create a change set for a new stack, CloudFormation creates a stack with a unique stack ID, but no
* template or resources. The stack will be in the REVIEW_IN_PROGRESS state until you execute the change set.
*
*
* By default, CloudFormation specifies UPDATE. You can't use the UPDATE type to create a
* change set for a new stack or the CREATE type to create a change set for an existing stack.
*
*
* @param changeSetType
* The type of change set operation. To create a change set for a new stack, specify CREATE. To
* create a change set for an existing stack, specify UPDATE. To create a change set for an
* import operation, specify IMPORT.
*
* If you create a change set for a new stack, CloudFormation creates a stack with a unique stack ID, but no
* template or resources. The stack will be in the REVIEW_IN_PROGRESS state until you execute the change set.
*
*
* By default, CloudFormation specifies UPDATE. You can't use the UPDATE type to
* create a change set for a new stack or the CREATE type to create a change set for an existing
* stack.
* @see ChangeSetType
*/
public void setChangeSetType(ChangeSetType changeSetType) {
withChangeSetType(changeSetType);
}
/**
*
* The type of change set operation. To create a change set for a new stack, specify CREATE. To create
* a change set for an existing stack, specify UPDATE. To create a change set for an import operation,
* specify IMPORT.
*
*
* If you create a change set for a new stack, CloudFormation creates a stack with a unique stack ID, but no
* template or resources. The stack will be in the REVIEW_IN_PROGRESS state until you execute the change set.
*
*
* By default, CloudFormation specifies UPDATE. You can't use the UPDATE type to create a
* change set for a new stack or the CREATE type to create a change set for an existing stack.
*
*
* @param changeSetType
* The type of change set operation. To create a change set for a new stack, specify CREATE. To
* create a change set for an existing stack, specify UPDATE. To create a change set for an
* import operation, specify IMPORT.
*
* If you create a change set for a new stack, CloudFormation creates a stack with a unique stack ID, but no
* template or resources. The stack will be in the REVIEW_IN_PROGRESS state until you execute the change set.
*
*
* By default, CloudFormation specifies UPDATE. You can't use the UPDATE type to
* create a change set for a new stack or the CREATE type to create a change set for an existing
* stack.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ChangeSetType
*/
public CreateChangeSetRequest withChangeSetType(ChangeSetType changeSetType) {
this.changeSetType = changeSetType.toString();
return this;
}
/**
*
* The resources to import into your stack.
*
*
* @return The resources to import into your stack.
*/
public java.util.List getResourcesToImport() {
if (resourcesToImport == null) {
resourcesToImport = new com.amazonaws.internal.SdkInternalList();
}
return resourcesToImport;
}
/**
*
* The resources to import into your stack.
*
*
* @param resourcesToImport
* The resources to import into your stack.
*/
public void setResourcesToImport(java.util.Collection resourcesToImport) {
if (resourcesToImport == null) {
this.resourcesToImport = null;
return;
}
this.resourcesToImport = new com.amazonaws.internal.SdkInternalList(resourcesToImport);
}
/**
*
* The resources to import into your stack.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setResourcesToImport(java.util.Collection)} or {@link #withResourcesToImport(java.util.Collection)} if
* you want to override the existing values.
*
*
* @param resourcesToImport
* The resources to import into your stack.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateChangeSetRequest withResourcesToImport(ResourceToImport... resourcesToImport) {
if (this.resourcesToImport == null) {
setResourcesToImport(new com.amazonaws.internal.SdkInternalList(resourcesToImport.length));
}
for (ResourceToImport ele : resourcesToImport) {
this.resourcesToImport.add(ele);
}
return this;
}
/**
*
* The resources to import into your stack.
*
*
* @param resourcesToImport
* The resources to import into your stack.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateChangeSetRequest withResourcesToImport(java.util.Collection resourcesToImport) {
setResourcesToImport(resourcesToImport);
return this;
}
/**
*
* Creates a change set for the all nested stacks specified in the template. The default behavior of this action is
* set to False. To include nested sets in a change set, specify True.
*
*
* @param includeNestedStacks
* Creates a change set for the all nested stacks specified in the template. The default behavior of this
* action is set to False. To include nested sets in a change set, specify True.
*/
public void setIncludeNestedStacks(Boolean includeNestedStacks) {
this.includeNestedStacks = includeNestedStacks;
}
/**
*
* Creates a change set for the all nested stacks specified in the template. The default behavior of this action is
* set to False. To include nested sets in a change set, specify True.
*
*
* @return Creates a change set for the all nested stacks specified in the template. The default behavior of this
* action is set to False. To include nested sets in a change set, specify True.
*/
public Boolean getIncludeNestedStacks() {
return this.includeNestedStacks;
}
/**
*
* Creates a change set for the all nested stacks specified in the template. The default behavior of this action is
* set to False. To include nested sets in a change set, specify True.
*
*
* @param includeNestedStacks
* Creates a change set for the all nested stacks specified in the template. The default behavior of this
* action is set to False. To include nested sets in a change set, specify True.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateChangeSetRequest withIncludeNestedStacks(Boolean includeNestedStacks) {
setIncludeNestedStacks(includeNestedStacks);
return this;
}
/**
*
* Creates a change set for the all nested stacks specified in the template. The default behavior of this action is
* set to False. To include nested sets in a change set, specify True.
*
*
* @return Creates a change set for the all nested stacks specified in the template. The default behavior of this
* action is set to False. To include nested sets in a change set, specify True.
*/
public Boolean isIncludeNestedStacks() {
return this.includeNestedStacks;
}
/**
*
* Determines what action will be taken if stack creation fails. If this parameter is specified, the
* DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these values:
*
*
* -
*
* DELETE - Deletes the change set if the stack creation fails. This is only valid when the
* ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the
* status of the stack is DELETE_FAILED.
*
*
* -
*
* DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying
* true for the DisableRollback parameter to the ExecuteChangeSet API operation.
*
*
* -
*
* ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying
* false for the DisableRollback parameter to the ExecuteChangeSet API operation.
*
*
*
*
* For nested stacks, when the OnStackFailure parameter is set to DELETE for the change
* set for the parent stack, any failure in a child stack will cause the parent stack creation to fail and all
* stacks to be deleted.
*
*
* @param onStackFailure
* Determines what action will be taken if stack creation fails. If this parameter is specified, the
* DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these values:
*
* -
*
* DELETE - Deletes the change set if the stack creation fails. This is only valid when the
* ChangeSetType parameter is set to CREATE. If the deletion of the stack fails,
* the status of the stack is DELETE_FAILED.
*
*
* -
*
* DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying
* true for the DisableRollback parameter to the ExecuteChangeSet API operation.
*
*
* -
*
* ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying
* false for the DisableRollback parameter to the ExecuteChangeSet API operation.
*
*
*
*
* For nested stacks, when the OnStackFailure parameter is set to DELETE for the
* change set for the parent stack, any failure in a child stack will cause the parent stack creation to fail
* and all stacks to be deleted.
* @see OnStackFailure
*/
public void setOnStackFailure(String onStackFailure) {
this.onStackFailure = onStackFailure;
}
/**
*
* Determines what action will be taken if stack creation fails. If this parameter is specified, the
* DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these values:
*
*
* -
*
* DELETE - Deletes the change set if the stack creation fails. This is only valid when the
* ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the
* status of the stack is DELETE_FAILED.
*
*
* -
*
* DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying
* true for the DisableRollback parameter to the ExecuteChangeSet API operation.
*
*
* -
*
* ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying
* false for the DisableRollback parameter to the ExecuteChangeSet API operation.
*
*
*
*
* For nested stacks, when the OnStackFailure parameter is set to DELETE for the change
* set for the parent stack, any failure in a child stack will cause the parent stack creation to fail and all
* stacks to be deleted.
*
*
* @return Determines what action will be taken if stack creation fails. If this parameter is specified, the
* DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these values:
*
* -
*
* DELETE - Deletes the change set if the stack creation fails. This is only valid when the
* ChangeSetType parameter is set to CREATE. If the deletion of the stack fails,
* the status of the stack is DELETE_FAILED.
*
*
* -
*
* DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying
* true for the DisableRollback parameter to the ExecuteChangeSet API operation.
*
*
* -
*
* ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to
* specifying false for the DisableRollback parameter to the ExecuteChangeSet API operation.
*
*
*
*
* For nested stacks, when the OnStackFailure parameter is set to DELETE for the
* change set for the parent stack, any failure in a child stack will cause the parent stack creation to
* fail and all stacks to be deleted.
* @see OnStackFailure
*/
public String getOnStackFailure() {
return this.onStackFailure;
}
/**
*
* Determines what action will be taken if stack creation fails. If this parameter is specified, the
* DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these values:
*
*
* -
*
* DELETE - Deletes the change set if the stack creation fails. This is only valid when the
* ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the
* status of the stack is DELETE_FAILED.
*
*
* -
*
* DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying
* true for the DisableRollback parameter to the ExecuteChangeSet API operation.
*
*
* -
*
* ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying
* false for the DisableRollback parameter to the ExecuteChangeSet API operation.
*
*
*
*
* For nested stacks, when the OnStackFailure parameter is set to DELETE for the change
* set for the parent stack, any failure in a child stack will cause the parent stack creation to fail and all
* stacks to be deleted.
*
*
* @param onStackFailure
* Determines what action will be taken if stack creation fails. If this parameter is specified, the
* DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these values:
*
* -
*
* DELETE - Deletes the change set if the stack creation fails. This is only valid when the
* ChangeSetType parameter is set to CREATE. If the deletion of the stack fails,
* the status of the stack is DELETE_FAILED.
*
*
* -
*
* DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying
* true for the DisableRollback parameter to the ExecuteChangeSet API operation.
*
*
* -
*
* ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying
* false for the DisableRollback parameter to the ExecuteChangeSet API operation.
*
*
*
*
* For nested stacks, when the OnStackFailure parameter is set to DELETE for the
* change set for the parent stack, any failure in a child stack will cause the parent stack creation to fail
* and all stacks to be deleted.
* @return Returns a reference to this object so that method calls can be chained together.
* @see OnStackFailure
*/
public CreateChangeSetRequest withOnStackFailure(String onStackFailure) {
setOnStackFailure(onStackFailure);
return this;
}
/**
*
* Determines what action will be taken if stack creation fails. If this parameter is specified, the
* DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these values:
*
*
* -
*
* DELETE - Deletes the change set if the stack creation fails. This is only valid when the
* ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the
* status of the stack is DELETE_FAILED.
*
*
* -
*
* DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying
* true for the DisableRollback parameter to the ExecuteChangeSet API operation.
*
*
* -
*
* ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying
* false for the DisableRollback parameter to the ExecuteChangeSet API operation.
*
*
*
*
* For nested stacks, when the OnStackFailure parameter is set to DELETE for the change
* set for the parent stack, any failure in a child stack will cause the parent stack creation to fail and all
* stacks to be deleted.
*
*
* @param onStackFailure
* Determines what action will be taken if stack creation fails. If this parameter is specified, the
* DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these values:
*
* -
*
* DELETE - Deletes the change set if the stack creation fails. This is only valid when the
* ChangeSetType parameter is set to CREATE. If the deletion of the stack fails,
* the status of the stack is DELETE_FAILED.
*
*
* -
*
* DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying
* true for the DisableRollback parameter to the ExecuteChangeSet API operation.
*
*
* -
*
* ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying
* false for the DisableRollback parameter to the ExecuteChangeSet API operation.
*
*
*
*
* For nested stacks, when the OnStackFailure parameter is set to DELETE for the
* change set for the parent stack, any failure in a child stack will cause the parent stack creation to fail
* and all stacks to be deleted.
* @see OnStackFailure
*/
public void setOnStackFailure(OnStackFailure onStackFailure) {
withOnStackFailure(onStackFailure);
}
/**
*
* Determines what action will be taken if stack creation fails. If this parameter is specified, the
* DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these values:
*
*
* -
*
* DELETE - Deletes the change set if the stack creation fails. This is only valid when the
* ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the
* status of the stack is DELETE_FAILED.
*
*
* -
*
* DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying
* true for the DisableRollback parameter to the ExecuteChangeSet API operation.
*
*
* -
*
* ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying
* false for the DisableRollback parameter to the ExecuteChangeSet API operation.
*
*
*
*
* For nested stacks, when the OnStackFailure parameter is set to DELETE for the change
* set for the parent stack, any failure in a child stack will cause the parent stack creation to fail and all
* stacks to be deleted.
*
*
* @param onStackFailure
* Determines what action will be taken if stack creation fails. If this parameter is specified, the
* DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these values:
*
* -
*
* DELETE - Deletes the change set if the stack creation fails. This is only valid when the
* ChangeSetType parameter is set to CREATE. If the deletion of the stack fails,
* the status of the stack is DELETE_FAILED.
*
*
* -
*
* DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying
* true for the DisableRollback parameter to the ExecuteChangeSet API operation.
*
*
* -
*
* ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying
* false for the DisableRollback parameter to the ExecuteChangeSet API operation.
*
*
*
*
* For nested stacks, when the OnStackFailure parameter is set to DELETE for the
* change set for the parent stack, any failure in a child stack will cause the parent stack creation to fail
* and all stacks to be deleted.
* @return Returns a reference to this object so that method calls can be chained together.
* @see OnStackFailure
*/
public CreateChangeSetRequest withOnStackFailure(OnStackFailure onStackFailure) {
this.onStackFailure = onStackFailure.toString();
return this;
}
/**
*
* Indicates if the stack set imports resources that already exist.
*
*
*
* This parameter can only import resources that have custom names in templates. For more information, see name type in
* the CloudFormation User Guide. To import resources that do not accept custom names, such as EC2 instances,
* use the resource import feature instead. For more information, see Bringing existing
* resources into CloudFormation management in the CloudFormation User Guide.
*
*
*
* @param importExistingResources
* Indicates if the stack set imports resources that already exist.
*
* This parameter can only import resources that have custom names in templates. For more information, see name
* type in the CloudFormation User Guide. To import resources that do not accept custom names,
* such as EC2 instances, use the resource import feature instead. For more information, see Bringing
* existing resources into CloudFormation management in the CloudFormation User Guide.
*
*/
public void setImportExistingResources(Boolean importExistingResources) {
this.importExistingResources = importExistingResources;
}
/**
*
* Indicates if the stack set imports resources that already exist.
*
*
*
* This parameter can only import resources that have custom names in templates. For more information, see name type in
* the CloudFormation User Guide. To import resources that do not accept custom names, such as EC2 instances,
* use the resource import feature instead. For more information, see Bringing existing
* resources into CloudFormation management in the CloudFormation User Guide.
*
*
*
* @return Indicates if the stack set imports resources that already exist.
*
* This parameter can only import resources that have custom names in templates. For more information, see
* name
* type in the CloudFormation User Guide. To import resources that do not accept custom names,
* such as EC2 instances, use the resource import feature instead. For more information, see Bringing
* existing resources into CloudFormation management in the CloudFormation User Guide.
*
*/
public Boolean getImportExistingResources() {
return this.importExistingResources;
}
/**
*
* Indicates if the stack set imports resources that already exist.
*
*
*
* This parameter can only import resources that have custom names in templates. For more information, see name type in
* the CloudFormation User Guide. To import resources that do not accept custom names, such as EC2 instances,
* use the resource import feature instead. For more information, see Bringing existing
* resources into CloudFormation management in the CloudFormation User Guide.
*
*
*
* @param importExistingResources
* Indicates if the stack set imports resources that already exist.
*
* This parameter can only import resources that have custom names in templates. For more information, see name
* type in the CloudFormation User Guide. To import resources that do not accept custom names,
* such as EC2 instances, use the resource import feature instead. For more information, see Bringing
* existing resources into CloudFormation management in the CloudFormation User Guide.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateChangeSetRequest withImportExistingResources(Boolean importExistingResources) {
setImportExistingResources(importExistingResources);
return this;
}
/**
*
* Indicates if the stack set imports resources that already exist.
*
*
*
* This parameter can only import resources that have custom names in templates. For more information, see name type in
* the CloudFormation User Guide. To import resources that do not accept custom names, such as EC2 instances,
* use the resource import feature instead. For more information, see Bringing existing
* resources into CloudFormation management in the CloudFormation User Guide.
*
*
*
* @return Indicates if the stack set imports resources that already exist.
*
* This parameter can only import resources that have custom names in templates. For more information, see
* name
* type in the CloudFormation User Guide. To import resources that do not accept custom names,
* such as EC2 instances, use the resource import feature instead. For more information, see Bringing
* existing resources into CloudFormation management in the CloudFormation User Guide.
*
*/
public Boolean isImportExistingResources() {
return this.importExistingResources;
}
/**
* 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 (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 (getNotificationARNs() != null)
sb.append("NotificationARNs: ").append(getNotificationARNs()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags()).append(",");
if (getChangeSetName() != null)
sb.append("ChangeSetName: ").append(getChangeSetName()).append(",");
if (getClientToken() != null)
sb.append("ClientToken: ").append(getClientToken()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getChangeSetType() != null)
sb.append("ChangeSetType: ").append(getChangeSetType()).append(",");
if (getResourcesToImport() != null)
sb.append("ResourcesToImport: ").append(getResourcesToImport()).append(",");
if (getIncludeNestedStacks() != null)
sb.append("IncludeNestedStacks: ").append(getIncludeNestedStacks()).append(",");
if (getOnStackFailure() != null)
sb.append("OnStackFailure: ").append(getOnStackFailure()).append(",");
if (getImportExistingResources() != null)
sb.append("ImportExistingResources: ").append(getImportExistingResources());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateChangeSetRequest == false)
return false;
CreateChangeSetRequest other = (CreateChangeSetRequest) 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.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.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.getChangeSetName() == null ^ this.getChangeSetName() == null)
return false;
if (other.getChangeSetName() != null && other.getChangeSetName().equals(this.getChangeSetName()) == false)
return false;
if (other.getClientToken() == null ^ this.getClientToken() == null)
return false;
if (other.getClientToken() != null && other.getClientToken().equals(this.getClientToken()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getChangeSetType() == null ^ this.getChangeSetType() == null)
return false;
if (other.getChangeSetType() != null && other.getChangeSetType().equals(this.getChangeSetType()) == false)
return false;
if (other.getResourcesToImport() == null ^ this.getResourcesToImport() == null)
return false;
if (other.getResourcesToImport() != null && other.getResourcesToImport().equals(this.getResourcesToImport()) == false)
return false;
if (other.getIncludeNestedStacks() == null ^ this.getIncludeNestedStacks() == null)
return false;
if (other.getIncludeNestedStacks() != null && other.getIncludeNestedStacks().equals(this.getIncludeNestedStacks()) == false)
return false;
if (other.getOnStackFailure() == null ^ this.getOnStackFailure() == null)
return false;
if (other.getOnStackFailure() != null && other.getOnStackFailure().equals(this.getOnStackFailure()) == false)
return false;
if (other.getImportExistingResources() == null ^ this.getImportExistingResources() == null)
return false;
if (other.getImportExistingResources() != null && other.getImportExistingResources().equals(this.getImportExistingResources()) == 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 + ((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 + ((getNotificationARNs() == null) ? 0 : getNotificationARNs().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
hashCode = prime * hashCode + ((getChangeSetName() == null) ? 0 : getChangeSetName().hashCode());
hashCode = prime * hashCode + ((getClientToken() == null) ? 0 : getClientToken().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getChangeSetType() == null) ? 0 : getChangeSetType().hashCode());
hashCode = prime * hashCode + ((getResourcesToImport() == null) ? 0 : getResourcesToImport().hashCode());
hashCode = prime * hashCode + ((getIncludeNestedStacks() == null) ? 0 : getIncludeNestedStacks().hashCode());
hashCode = prime * hashCode + ((getOnStackFailure() == null) ? 0 : getOnStackFailure().hashCode());
hashCode = prime * hashCode + ((getImportExistingResources() == null) ? 0 : getImportExistingResources().hashCode());
return hashCode;
}
@Override
public CreateChangeSetRequest clone() {
return (CreateChangeSetRequest) super.clone();
}
}