com.amazonaws.services.cloudformation.model.CreateStackRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-cloudformation Show documentation
/*
* Copyright 2014-2019 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 CreateStack action.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateStackRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name that is associated with the stack. The name must be unique in the region in which you are creating the
* stack.
*
*
*
* A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an
* alphabetic character and cannot be longer than 128 characters.
*
*
*/
private String stackName;
/**
*
* Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For
* more information, go to Template Anatomy
* in the AWS CloudFormation User Guide.
*
*
* Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but
* not both.
*
*/
private String templateBody;
/**
*
* Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is
* located in an Amazon S3 bucket. For more information, go to the Template Anatomy
* in the AWS CloudFormation User Guide.
*
*
* Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but
* not both.
*
*/
private String templateURL;
/**
*
* A list of Parameter structures that specify input parameters for the stack. For more information,
* see the Parameter data
* type.
*
*/
private com.amazonaws.internal.SdkInternalList parameters;
/**
*
* Set to true to disable rollback of the stack if stack creation failed. You can specify either
* DisableRollback or OnFailure, but not both.
*
*
* Default: false
*
*/
private Boolean disableRollback;
/**
*
* The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for
* the specified monitoring period afterwards.
*
*/
private RollbackConfiguration rollbackConfiguration;
/**
*
* The amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableRollback
* is not set or is set to false, the stack will be rolled back.
*
*/
private Integer timeoutInMinutes;
/**
*
* The Simple Notification Service (SNS) topic ARNs to publish stack related events. You can find your SNS topic
* ARNs using the SNS console or your Command Line Interface (CLI).
*
*/
private com.amazonaws.internal.SdkInternalList notificationARNs;
/**
*
* In some cases, you must explicity acknowledge that your stack template contains certain capabilities in order for
* AWS CloudFormation to create the stack.
*
*
* -
*
* CAPABILITY_IAM and CAPABILITY_NAMED_IAM
*
*
* Some stack templates might include resources that can affect permissions in your AWS account; for example, by
* creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge
* this by specifying one of these capabilities.
*
*
* The following IAM resources require you to specify either the CAPABILITY_IAM or
* CAPABILITY_NAMED_IAM capability.
*
*
* -
*
* If you have IAM resources, you can specify either capability.
*
*
* -
*
* If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
*
*
* -
*
* If you don't specify either of these capabilities, AWS CloudFormation returns an
* InsufficientCapabilities error.
*
*
*
*
* If your stack template contains these resources, we recommend that you review all permissions associated with
* them and edit their permissions if necessary.
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
* AWS::IAM::Role
*
*
* -
*
*
* AWS::IAM::User
*
*
* -
*
*
*
*
* For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
*
*
* -
*
* CAPABILITY_AUTO_EXPAND
*
*
* Some template contain macros. Macros perform custom processing on templates; this can include simple actions like
* find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users
* typically create a change set from the processed template, so that they can review the changes resulting from the
* macros before actually creating the stack. If your stack template contains one or more macros, and you choose to
* create a stack directly from the processed template, without first reviewing the resulting changes in a change
* set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.
*
*
* Change sets do not currently support nested stacks. If you want to create a stack from a stack template that
* contains macros and nested stacks, you must create the stack directly from the template using this
* capability.
*
*
*
* You should only create stacks directly from a stack template that contains macros if you know what processing the
* macro performs.
*
*
* Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the
* Lambda function owner can update the function operation without AWS CloudFormation being notified.
*
*
*
* For more information, see Using AWS
* CloudFormation Macros to Perform Custom Processing on Templates.
*
*
*
*/
private com.amazonaws.internal.SdkInternalList capabilities;
/**
*
* The template resource types that you have permissions to work with for this create stack action, such as
* AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. Use the
* following syntax to describe template resource types: AWS::* (for all AWS resource),
* Custom::* (for all custom resources), Custom::logical_ID (for a specific custom
* resource), AWS::service_name::* (for all resources of a particular AWS service), and
* AWS::service_name::resource_logical_ID (for a specific AWS resource).
*
*
* If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By
* default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM)
* uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access
* with AWS Identity and Access Management.
*
*/
private com.amazonaws.internal.SdkInternalList resourceTypes;
/**
*
* The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation
* assumes to create the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS
* CloudFormation always uses this role for all future operations on the stack. As long as users have permission to
* operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it.
* Ensure that the role grants least privilege.
*
*
* If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If
* no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.
*
*/
private String roleARN;
/**
*
* Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or
* DELETE. You can specify either OnFailure or DisableRollback, but not both.
*
*
* Default: ROLLBACK
*
*/
private String onFailure;
/**
*
* Structure containing the stack policy body. For more information, go to Prevent
* Updates to Stack Resources in the AWS CloudFormation User Guide. You can specify either the
* StackPolicyBody or the StackPolicyURL parameter, but not both.
*
*/
private String stackPolicyBody;
/**
*
* Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in
* an S3 bucket in the same region as the stack. You can specify either the StackPolicyBody or the
* StackPolicyURL parameter, but not both.
*
*/
private String stackPolicyURL;
/**
*
* Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to the resources
* created in the stack. A maximum number of 50 tags can be specified.
*
*/
private com.amazonaws.internal.SdkInternalList tags;
/**
*
* A unique identifier for this CreateStack request. Specify this token if you plan to retry requests
* so that AWS CloudFormation knows that you're not attempting to create a stack with the same name. You might retry
* CreateStack requests to ensure that AWS CloudFormation successfully received them.
*
*
* All events triggered by a given stack operation are assigned the same client request token, which you can use to
* track operations. For example, if you execute a CreateStack operation with the token
* token1, then all the StackEvents generated by that operation will have
* ClientRequestToken set as token1.
*
*
* In the console, stack operations display the client request token on the Events tab. Stack operations that are
* initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify
* the stack operation . For example, if you create a stack using the console, each stack event would be assigned
* the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
*
*/
private String clientRequestToken;
/**
*
* Whether to enable termination protection on the specified stack. If a user attempts to delete a stack with
* termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a
* Stack From Being Deleted in the AWS CloudFormation User Guide. Termination protection is disabled on
* stacks by default.
*
*
* For nested
* stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack.
*
*/
private Boolean enableTerminationProtection;
/**
*
* The name that is associated with the stack. The name must be unique in the region in which you are creating the
* stack.
*
*
*
* A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an
* alphabetic character and cannot be longer than 128 characters.
*
*
*
* @param stackName
* The name that is associated with the stack. The name must be unique in the region in which you are
* creating the stack.
*
* A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an
* alphabetic character and cannot be longer than 128 characters.
*
*/
public void setStackName(String stackName) {
this.stackName = stackName;
}
/**
*
* The name that is associated with the stack. The name must be unique in the region in which you are creating the
* stack.
*
*
*
* A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an
* alphabetic character and cannot be longer than 128 characters.
*
*
*
* @return The name that is associated with the stack. The name must be unique in the region in which you are
* creating the stack.
*
* A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an
* alphabetic character and cannot be longer than 128 characters.
*
*/
public String getStackName() {
return this.stackName;
}
/**
*
* The name that is associated with the stack. The name must be unique in the region in which you are creating the
* stack.
*
*
*
* A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an
* alphabetic character and cannot be longer than 128 characters.
*
*
*
* @param stackName
* The name that is associated with the stack. The name must be unique in the region in which you are
* creating the stack.
*
* A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an
* alphabetic character and cannot be longer than 128 characters.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateStackRequest withStackName(String stackName) {
setStackName(stackName);
return this;
}
/**
*
* Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For
* more information, go to Template Anatomy
* in the AWS CloudFormation User Guide.
*
*
* Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but
* not both.
*
*
* @param templateBody
* Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200
* bytes. For more information, go to Template
* Anatomy in the AWS CloudFormation User Guide.
*
* Conditional: You must specify either the TemplateBody or the TemplateURL
* parameter, but not both.
*/
public void setTemplateBody(String templateBody) {
this.templateBody = templateBody;
}
/**
*
* Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For
* more information, go to Template Anatomy
* in the AWS CloudFormation User Guide.
*
*
* Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but
* not both.
*
*
* @return Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200
* bytes. For more information, go to Template
* Anatomy in the AWS CloudFormation User Guide.
*
* Conditional: You must specify either the TemplateBody or the TemplateURL
* parameter, but not both.
*/
public String getTemplateBody() {
return this.templateBody;
}
/**
*
* Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For
* more information, go to Template Anatomy
* in the AWS CloudFormation User Guide.
*
*
* Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but
* not both.
*
*
* @param templateBody
* Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200
* bytes. For more information, go to Template
* Anatomy in the AWS CloudFormation User Guide.
*
* Conditional: You must specify either the TemplateBody or the TemplateURL
* parameter, but not both.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateStackRequest withTemplateBody(String templateBody) {
setTemplateBody(templateBody);
return this;
}
/**
*
* Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is
* located in an Amazon S3 bucket. For more information, go to the Template Anatomy
* in the AWS CloudFormation User Guide.
*
*
* Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but
* not both.
*
*
* @param templateURL
* Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes)
* that is located in an Amazon S3 bucket. For more information, go to the Template
* Anatomy in the AWS CloudFormation User Guide.
*
* Conditional: You must specify either the TemplateBody or the TemplateURL
* parameter, but not both.
*/
public void setTemplateURL(String templateURL) {
this.templateURL = templateURL;
}
/**
*
* Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is
* located in an Amazon S3 bucket. For more information, go to the Template Anatomy
* in the AWS CloudFormation User Guide.
*
*
* Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but
* not both.
*
*
* @return Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes)
* that is located in an Amazon S3 bucket. For more information, go to the Template
* Anatomy in the AWS CloudFormation User Guide.
*
* Conditional: You must specify either the TemplateBody or the TemplateURL
* parameter, but not both.
*/
public String getTemplateURL() {
return this.templateURL;
}
/**
*
* Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is
* located in an Amazon S3 bucket. For more information, go to the Template Anatomy
* in the AWS CloudFormation User Guide.
*
*
* Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but
* not both.
*
*
* @param templateURL
* Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes)
* that is located in an Amazon S3 bucket. For more information, go to the Template
* Anatomy in the AWS CloudFormation User Guide.
*
* Conditional: You must specify either the TemplateBody or the TemplateURL
* parameter, but not both.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateStackRequest withTemplateURL(String templateURL) {
setTemplateURL(templateURL);
return this;
}
/**
*
* A list of Parameter structures that specify input parameters for the stack. For more information,
* see the Parameter data
* type.
*
*
* @return A list of Parameter structures that specify input parameters for the stack. For more
* information, see the Parameter
* data type.
*/
public java.util.List getParameters() {
if (parameters == null) {
parameters = new com.amazonaws.internal.SdkInternalList();
}
return parameters;
}
/**
*
* A list of Parameter structures that specify input parameters for the stack. For more information,
* see the Parameter data
* type.
*
*
* @param parameters
* A list of Parameter structures that specify input parameters for the stack. For more
* information, see the Parameter
* data type.
*/
public void setParameters(java.util.Collection parameters) {
if (parameters == null) {
this.parameters = null;
return;
}
this.parameters = new com.amazonaws.internal.SdkInternalList(parameters);
}
/**
*
* A list of Parameter structures that specify input parameters for the stack. For more information,
* see the Parameter data
* type.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setParameters(java.util.Collection)} or {@link #withParameters(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param parameters
* A list of Parameter structures that specify input parameters for the stack. For more
* information, see the Parameter
* data type.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateStackRequest withParameters(Parameter... parameters) {
if (this.parameters == null) {
setParameters(new com.amazonaws.internal.SdkInternalList(parameters.length));
}
for (Parameter ele : parameters) {
this.parameters.add(ele);
}
return this;
}
/**
*
* A list of Parameter structures that specify input parameters for the stack. For more information,
* see the Parameter data
* type.
*
*
* @param parameters
* A list of Parameter structures that specify input parameters for the stack. For more
* information, see the Parameter
* data type.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateStackRequest withParameters(java.util.Collection parameters) {
setParameters(parameters);
return this;
}
/**
*
* Set to true to disable rollback of the stack if stack creation failed. You can specify either
* DisableRollback or OnFailure, but not both.
*
*
* Default: false
*
*
* @param disableRollback
* Set to true to disable rollback of the stack if stack creation failed. You can specify either
* DisableRollback or OnFailure, but not both.
*
* Default: false
*/
public void setDisableRollback(Boolean disableRollback) {
this.disableRollback = disableRollback;
}
/**
*
* Set to true to disable rollback of the stack if stack creation failed. You can specify either
* DisableRollback or OnFailure, but not both.
*
*
* Default: false
*
*
* @return Set to true to disable rollback of the stack if stack creation failed. You can specify
* either DisableRollback or OnFailure, but not both.
*
* Default: false
*/
public Boolean getDisableRollback() {
return this.disableRollback;
}
/**
*
* Set to true to disable rollback of the stack if stack creation failed. You can specify either
* DisableRollback or OnFailure, but not both.
*
*
* Default: false
*
*
* @param disableRollback
* Set to true to disable rollback of the stack if stack creation failed. You can specify either
* DisableRollback or OnFailure, but not both.
*
* Default: false
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateStackRequest withDisableRollback(Boolean disableRollback) {
setDisableRollback(disableRollback);
return this;
}
/**
*
* Set to true to disable rollback of the stack if stack creation failed. You can specify either
* DisableRollback or OnFailure, but not both.
*
*
* Default: false
*
*
* @return Set to true to disable rollback of the stack if stack creation failed. You can specify
* either DisableRollback or OnFailure, but not both.
*
* Default: false
*/
public Boolean isDisableRollback() {
return this.disableRollback;
}
/**
*
* The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for
* the specified monitoring period afterwards.
*
*
* @param rollbackConfiguration
* The rollback triggers for AWS 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 AWS CloudFormation to monitor during stack creation and updating operations, and for
* the specified monitoring period afterwards.
*
*
* @return The rollback triggers for AWS 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 AWS CloudFormation to monitor during stack creation and updating operations, and for
* the specified monitoring period afterwards.
*
*
* @param rollbackConfiguration
* The rollback triggers for AWS 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 CreateStackRequest withRollbackConfiguration(RollbackConfiguration rollbackConfiguration) {
setRollbackConfiguration(rollbackConfiguration);
return this;
}
/**
*
* The amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableRollback
* is not set or is set to false, the stack will be rolled back.
*
*
* @param timeoutInMinutes
* The amount of time that can pass before the stack status becomes CREATE_FAILED; if
* DisableRollback is not set or is set to false, the stack will be rolled back.
*/
public void setTimeoutInMinutes(Integer timeoutInMinutes) {
this.timeoutInMinutes = timeoutInMinutes;
}
/**
*
* The amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableRollback
* is not set or is set to false, the stack will be rolled back.
*
*
* @return The amount of time that can pass before the stack status becomes CREATE_FAILED; if
* DisableRollback is not set or is set to false, the stack will be rolled back.
*/
public Integer getTimeoutInMinutes() {
return this.timeoutInMinutes;
}
/**
*
* The amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableRollback
* is not set or is set to false, the stack will be rolled back.
*
*
* @param timeoutInMinutes
* The amount of time that can pass before the stack status becomes CREATE_FAILED; if
* DisableRollback is not set or is set to false, the stack will be rolled back.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateStackRequest withTimeoutInMinutes(Integer timeoutInMinutes) {
setTimeoutInMinutes(timeoutInMinutes);
return this;
}
/**
*
* The Simple Notification Service (SNS) topic ARNs to publish stack related events. You can find your SNS topic
* ARNs using the SNS console or your Command Line Interface (CLI).
*
*
* @return The Simple Notification Service (SNS) topic ARNs to publish stack related events. You can find your SNS
* topic ARNs using the SNS console or your Command Line Interface (CLI).
*/
public java.util.List getNotificationARNs() {
if (notificationARNs == null) {
notificationARNs = new com.amazonaws.internal.SdkInternalList();
}
return notificationARNs;
}
/**
*
* The Simple Notification Service (SNS) topic ARNs to publish stack related events. You can find your SNS topic
* ARNs using the SNS console or your Command Line Interface (CLI).
*
*
* @param notificationARNs
* The Simple Notification Service (SNS) topic ARNs to publish stack related events. You can find your SNS
* topic ARNs using the SNS console or your Command Line Interface (CLI).
*/
public void setNotificationARNs(java.util.Collection notificationARNs) {
if (notificationARNs == null) {
this.notificationARNs = null;
return;
}
this.notificationARNs = new com.amazonaws.internal.SdkInternalList(notificationARNs);
}
/**
*
* The Simple Notification Service (SNS) topic ARNs to publish stack related events. You can find your SNS topic
* ARNs using the SNS console or your Command Line Interface (CLI).
*
*
* 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 Simple Notification Service (SNS) topic ARNs to publish stack related events. You can find your SNS
* topic ARNs using the SNS console or your Command Line Interface (CLI).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateStackRequest 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 Simple Notification Service (SNS) topic ARNs to publish stack related events. You can find your SNS topic
* ARNs using the SNS console or your Command Line Interface (CLI).
*
*
* @param notificationARNs
* The Simple Notification Service (SNS) topic ARNs to publish stack related events. You can find your SNS
* topic ARNs using the SNS console or your Command Line Interface (CLI).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateStackRequest withNotificationARNs(java.util.Collection notificationARNs) {
setNotificationARNs(notificationARNs);
return this;
}
/**
*
* In some cases, you must explicity acknowledge that your stack template contains certain capabilities in order for
* AWS CloudFormation to create the stack.
*
*
* -
*
* CAPABILITY_IAM and CAPABILITY_NAMED_IAM
*
*
* Some stack templates might include resources that can affect permissions in your AWS account; for example, by
* creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge
* this by specifying one of these capabilities.
*
*
* The following IAM resources require you to specify either the CAPABILITY_IAM or
* CAPABILITY_NAMED_IAM capability.
*
*
* -
*
* If you have IAM resources, you can specify either capability.
*
*
* -
*
* If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
*
*
* -
*
* If you don't specify either of these capabilities, AWS CloudFormation returns an
* InsufficientCapabilities error.
*
*
*
*
* If your stack template contains these resources, we recommend that you review all permissions associated with
* them and edit their permissions if necessary.
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
* AWS::IAM::Role
*
*
* -
*
*
* AWS::IAM::User
*
*
* -
*
*
*
*
* For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
*
*
* -
*
* CAPABILITY_AUTO_EXPAND
*
*
* Some template contain macros. Macros perform custom processing on templates; this can include simple actions like
* find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users
* typically create a change set from the processed template, so that they can review the changes resulting from the
* macros before actually creating the stack. If your stack template contains one or more macros, and you choose to
* create a stack directly from the processed template, without first reviewing the resulting changes in a change
* set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.
*
*
* Change sets do not currently support nested stacks. If you want to create a stack from a stack template that
* contains macros and nested stacks, you must create the stack directly from the template using this
* capability.
*
*
*
* You should only create stacks directly from a stack template that contains macros if you know what processing the
* macro performs.
*
*
* Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the
* Lambda function owner can update the function operation without AWS CloudFormation being notified.
*
*
*
* For more information, see Using AWS
* CloudFormation Macros to Perform Custom Processing on Templates.
*
*
*
*
* @return In some cases, you must explicity acknowledge that your stack template contains certain capabilities in
* order for AWS CloudFormation to create the stack.
*
* -
*
* CAPABILITY_IAM and CAPABILITY_NAMED_IAM
*
*
* Some stack templates might include resources that can affect permissions in your AWS account; for
* example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must
* explicitly acknowledge this by specifying one of these capabilities.
*
*
* The following IAM resources require you to specify either the CAPABILITY_IAM or
* CAPABILITY_NAMED_IAM capability.
*
*
* -
*
* If you have IAM resources, you can specify either capability.
*
*
* -
*
* If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
*
*
* -
*
* If you don't specify either of these capabilities, AWS CloudFormation returns an
* InsufficientCapabilities error.
*
*
*
*
* If your stack template contains these resources, we recommend that you review all permissions associated
* with them and edit their permissions if necessary.
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
* AWS::IAM::Role
*
*
* -
*
*
* AWS::IAM::User
*
*
* -
*
*
*
*
* For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
*
*
* -
*
* CAPABILITY_AUTO_EXPAND
*
*
* Some template contain macros. Macros perform custom processing on templates; this can include simple
* actions like find-and-replace operations, all the way to extensive transformations of entire templates.
* Because of this, users typically create a change set from the processed template, so that they can review
* the changes resulting from the macros before actually creating the stack. If your stack template contains
* one or more macros, and you choose to create a stack directly from the processed template, without first
* reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the
* AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.
*
*
* Change sets do not currently support nested stacks. If you want to create a stack from a stack template
* that contains macros and nested stacks, you must create the stack directly from the template using
* this capability.
*
*
*
* You should only create stacks directly from a stack template that contains macros if you know what
* processing the macro performs.
*
*
* Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that
* the Lambda function owner can update the function operation without AWS CloudFormation being notified.
*
*
*
* For more information, see Using AWS
* CloudFormation Macros to Perform Custom Processing on Templates.
*
*
* @see Capability
*/
public java.util.List getCapabilities() {
if (capabilities == null) {
capabilities = new com.amazonaws.internal.SdkInternalList();
}
return capabilities;
}
/**
*
* In some cases, you must explicity acknowledge that your stack template contains certain capabilities in order for
* AWS CloudFormation to create the stack.
*
*
* -
*
* CAPABILITY_IAM and CAPABILITY_NAMED_IAM
*
*
* Some stack templates might include resources that can affect permissions in your AWS account; for example, by
* creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge
* this by specifying one of these capabilities.
*
*
* The following IAM resources require you to specify either the CAPABILITY_IAM or
* CAPABILITY_NAMED_IAM capability.
*
*
* -
*
* If you have IAM resources, you can specify either capability.
*
*
* -
*
* If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
*
*
* -
*
* If you don't specify either of these capabilities, AWS CloudFormation returns an
* InsufficientCapabilities error.
*
*
*
*
* If your stack template contains these resources, we recommend that you review all permissions associated with
* them and edit their permissions if necessary.
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
* AWS::IAM::Role
*
*
* -
*
*
* AWS::IAM::User
*
*
* -
*
*
*
*
* For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
*
*
* -
*
* CAPABILITY_AUTO_EXPAND
*
*
* Some template contain macros. Macros perform custom processing on templates; this can include simple actions like
* find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users
* typically create a change set from the processed template, so that they can review the changes resulting from the
* macros before actually creating the stack. If your stack template contains one or more macros, and you choose to
* create a stack directly from the processed template, without first reviewing the resulting changes in a change
* set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.
*
*
* Change sets do not currently support nested stacks. If you want to create a stack from a stack template that
* contains macros and nested stacks, you must create the stack directly from the template using this
* capability.
*
*
*
* You should only create stacks directly from a stack template that contains macros if you know what processing the
* macro performs.
*
*
* Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the
* Lambda function owner can update the function operation without AWS CloudFormation being notified.
*
*
*
* For more information, see Using AWS
* CloudFormation Macros to Perform Custom Processing on Templates.
*
*
*
*
* @param capabilities
* In some cases, you must explicity acknowledge that your stack template contains certain capabilities in
* order for AWS CloudFormation to create the stack.
*
* -
*
* CAPABILITY_IAM and CAPABILITY_NAMED_IAM
*
*
* Some stack templates might include resources that can affect permissions in your AWS account; for example,
* by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly
* acknowledge this by specifying one of these capabilities.
*
*
* The following IAM resources require you to specify either the CAPABILITY_IAM or
* CAPABILITY_NAMED_IAM capability.
*
*
* -
*
* If you have IAM resources, you can specify either capability.
*
*
* -
*
* If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
*
*
* -
*
* If you don't specify either of these capabilities, AWS CloudFormation returns an
* InsufficientCapabilities error.
*
*
*
*
* If your stack template contains these resources, we recommend that you review all permissions associated
* with them and edit their permissions if necessary.
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
* AWS::IAM::Role
*
*
* -
*
*
* AWS::IAM::User
*
*
* -
*
*
*
*
* For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
*
*
* -
*
* CAPABILITY_AUTO_EXPAND
*
*
* Some template contain macros. Macros perform custom processing on templates; this can include simple
* actions like find-and-replace operations, all the way to extensive transformations of entire templates.
* Because of this, users typically create a change set from the processed template, so that they can review
* the changes resulting from the macros before actually creating the stack. If your stack template contains
* one or more macros, and you choose to create a stack directly from the processed template, without first
* reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the
* AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.
*
*
* Change sets do not currently support nested stacks. If you want to create a stack from a stack template
* that contains macros and nested stacks, you must create the stack directly from the template using
* this capability.
*
*
*
* You should only create stacks directly from a stack template that contains macros if you know what
* processing the macro performs.
*
*
* Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that
* the Lambda function owner can update the function operation without AWS CloudFormation being notified.
*
*
*
* For more information, see Using AWS
* CloudFormation Macros to Perform Custom Processing on Templates.
*
*
* @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 explicity acknowledge that your stack template contains certain capabilities in order for
* AWS CloudFormation to create the stack.
*
*
* -
*
* CAPABILITY_IAM and CAPABILITY_NAMED_IAM
*
*
* Some stack templates might include resources that can affect permissions in your AWS account; for example, by
* creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge
* this by specifying one of these capabilities.
*
*
* The following IAM resources require you to specify either the CAPABILITY_IAM or
* CAPABILITY_NAMED_IAM capability.
*
*
* -
*
* If you have IAM resources, you can specify either capability.
*
*
* -
*
* If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
*
*
* -
*
* If you don't specify either of these capabilities, AWS CloudFormation returns an
* InsufficientCapabilities error.
*
*
*
*
* If your stack template contains these resources, we recommend that you review all permissions associated with
* them and edit their permissions if necessary.
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
* AWS::IAM::Role
*
*
* -
*
*
* AWS::IAM::User
*
*
* -
*
*
*
*
* For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
*
*
* -
*
* CAPABILITY_AUTO_EXPAND
*
*
* Some template contain macros. Macros perform custom processing on templates; this can include simple actions like
* find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users
* typically create a change set from the processed template, so that they can review the changes resulting from the
* macros before actually creating the stack. If your stack template contains one or more macros, and you choose to
* create a stack directly from the processed template, without first reviewing the resulting changes in a change
* set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.
*
*
* Change sets do not currently support nested stacks. If you want to create a stack from a stack template that
* contains macros and nested stacks, you must create the stack directly from the template using this
* capability.
*
*
*
* You should only create stacks directly from a stack template that contains macros if you know what processing the
* macro performs.
*
*
* Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the
* Lambda function owner can update the function operation without AWS CloudFormation being notified.
*
*
*
* For more information, see Using AWS
* CloudFormation Macros to Perform Custom Processing on Templates.
*
*
*
*
* 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 explicity acknowledge that your stack template contains certain capabilities in
* order for AWS CloudFormation to create the stack.
*
* -
*
* CAPABILITY_IAM and CAPABILITY_NAMED_IAM
*
*
* Some stack templates might include resources that can affect permissions in your AWS account; for example,
* by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly
* acknowledge this by specifying one of these capabilities.
*
*
* The following IAM resources require you to specify either the CAPABILITY_IAM or
* CAPABILITY_NAMED_IAM capability.
*
*
* -
*
* If you have IAM resources, you can specify either capability.
*
*
* -
*
* If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
*
*
* -
*
* If you don't specify either of these capabilities, AWS CloudFormation returns an
* InsufficientCapabilities error.
*
*
*
*
* If your stack template contains these resources, we recommend that you review all permissions associated
* with them and edit their permissions if necessary.
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
* AWS::IAM::Role
*
*
* -
*
*
* AWS::IAM::User
*
*
* -
*
*
*
*
* For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
*
*
* -
*
* CAPABILITY_AUTO_EXPAND
*
*
* Some template contain macros. Macros perform custom processing on templates; this can include simple
* actions like find-and-replace operations, all the way to extensive transformations of entire templates.
* Because of this, users typically create a change set from the processed template, so that they can review
* the changes resulting from the macros before actually creating the stack. If your stack template contains
* one or more macros, and you choose to create a stack directly from the processed template, without first
* reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the
* AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.
*
*
* Change sets do not currently support nested stacks. If you want to create a stack from a stack template
* that contains macros and nested stacks, you must create the stack directly from the template using
* this capability.
*
*
*
* You should only create stacks directly from a stack template that contains macros if you know what
* processing the macro performs.
*
*
* Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that
* the Lambda function owner can update the function operation without AWS CloudFormation being notified.
*
*
*
* For more information, see Using AWS
* CloudFormation Macros to Perform Custom Processing on Templates.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see Capability
*/
public CreateStackRequest 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 explicity acknowledge that your stack template contains certain capabilities in order for
* AWS CloudFormation to create the stack.
*
*
* -
*
* CAPABILITY_IAM and CAPABILITY_NAMED_IAM
*
*
* Some stack templates might include resources that can affect permissions in your AWS account; for example, by
* creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge
* this by specifying one of these capabilities.
*
*
* The following IAM resources require you to specify either the CAPABILITY_IAM or
* CAPABILITY_NAMED_IAM capability.
*
*
* -
*
* If you have IAM resources, you can specify either capability.
*
*
* -
*
* If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
*
*
* -
*
* If you don't specify either of these capabilities, AWS CloudFormation returns an
* InsufficientCapabilities error.
*
*
*
*
* If your stack template contains these resources, we recommend that you review all permissions associated with
* them and edit their permissions if necessary.
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
* AWS::IAM::Role
*
*
* -
*
*
* AWS::IAM::User
*
*
* -
*
*
*
*
* For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
*
*
* -
*
* CAPABILITY_AUTO_EXPAND
*
*
* Some template contain macros. Macros perform custom processing on templates; this can include simple actions like
* find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users
* typically create a change set from the processed template, so that they can review the changes resulting from the
* macros before actually creating the stack. If your stack template contains one or more macros, and you choose to
* create a stack directly from the processed template, without first reviewing the resulting changes in a change
* set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.
*
*
* Change sets do not currently support nested stacks. If you want to create a stack from a stack template that
* contains macros and nested stacks, you must create the stack directly from the template using this
* capability.
*
*
*
* You should only create stacks directly from a stack template that contains macros if you know what processing the
* macro performs.
*
*
* Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the
* Lambda function owner can update the function operation without AWS CloudFormation being notified.
*
*
*
* For more information, see Using AWS
* CloudFormation Macros to Perform Custom Processing on Templates.
*
*
*
*
* @param capabilities
* In some cases, you must explicity acknowledge that your stack template contains certain capabilities in
* order for AWS CloudFormation to create the stack.
*
* -
*
* CAPABILITY_IAM and CAPABILITY_NAMED_IAM
*
*
* Some stack templates might include resources that can affect permissions in your AWS account; for example,
* by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly
* acknowledge this by specifying one of these capabilities.
*
*
* The following IAM resources require you to specify either the CAPABILITY_IAM or
* CAPABILITY_NAMED_IAM capability.
*
*
* -
*
* If you have IAM resources, you can specify either capability.
*
*
* -
*
* If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
*
*
* -
*
* If you don't specify either of these capabilities, AWS CloudFormation returns an
* InsufficientCapabilities error.
*
*
*
*
* If your stack template contains these resources, we recommend that you review all permissions associated
* with them and edit their permissions if necessary.
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
* AWS::IAM::Role
*
*
* -
*
*
* AWS::IAM::User
*
*
* -
*
*
*
*
* For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
*
*
* -
*
* CAPABILITY_AUTO_EXPAND
*
*
* Some template contain macros. Macros perform custom processing on templates; this can include simple
* actions like find-and-replace operations, all the way to extensive transformations of entire templates.
* Because of this, users typically create a change set from the processed template, so that they can review
* the changes resulting from the macros before actually creating the stack. If your stack template contains
* one or more macros, and you choose to create a stack directly from the processed template, without first
* reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the
* AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.
*
*
* Change sets do not currently support nested stacks. If you want to create a stack from a stack template
* that contains macros and nested stacks, you must create the stack directly from the template using
* this capability.
*
*
*
* You should only create stacks directly from a stack template that contains macros if you know what
* processing the macro performs.
*
*
* Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that
* the Lambda function owner can update the function operation without AWS CloudFormation being notified.
*
*
*
* For more information, see Using AWS
* CloudFormation Macros to Perform Custom Processing on Templates.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see Capability
*/
public CreateStackRequest withCapabilities(java.util.Collection capabilities) {
setCapabilities(capabilities);
return this;
}
/**
*
* In some cases, you must explicity acknowledge that your stack template contains certain capabilities in order for
* AWS CloudFormation to create the stack.
*
*
* -
*
* CAPABILITY_IAM and CAPABILITY_NAMED_IAM
*
*
* Some stack templates might include resources that can affect permissions in your AWS account; for example, by
* creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge
* this by specifying one of these capabilities.
*
*
* The following IAM resources require you to specify either the CAPABILITY_IAM or
* CAPABILITY_NAMED_IAM capability.
*
*
* -
*
* If you have IAM resources, you can specify either capability.
*
*
* -
*
* If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
*
*
* -
*
* If you don't specify either of these capabilities, AWS CloudFormation returns an
* InsufficientCapabilities error.
*
*
*
*
* If your stack template contains these resources, we recommend that you review all permissions associated with
* them and edit their permissions if necessary.
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
* AWS::IAM::Role
*
*
* -
*
*
* AWS::IAM::User
*
*
* -
*
*
*
*
* For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
*
*
* -
*
* CAPABILITY_AUTO_EXPAND
*
*
* Some template contain macros. Macros perform custom processing on templates; this can include simple actions like
* find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users
* typically create a change set from the processed template, so that they can review the changes resulting from the
* macros before actually creating the stack. If your stack template contains one or more macros, and you choose to
* create a stack directly from the processed template, without first reviewing the resulting changes in a change
* set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.
*
*
* Change sets do not currently support nested stacks. If you want to create a stack from a stack template that
* contains macros and nested stacks, you must create the stack directly from the template using this
* capability.
*
*
*
* You should only create stacks directly from a stack template that contains macros if you know what processing the
* macro performs.
*
*
* Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the
* Lambda function owner can update the function operation without AWS CloudFormation being notified.
*
*
*
* For more information, see Using AWS
* CloudFormation Macros to Perform Custom Processing on Templates.
*
*
*
*
* @param capabilities
* In some cases, you must explicity acknowledge that your stack template contains certain capabilities in
* order for AWS CloudFormation to create the stack.
*
* -
*
* CAPABILITY_IAM and CAPABILITY_NAMED_IAM
*
*
* Some stack templates might include resources that can affect permissions in your AWS account; for example,
* by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly
* acknowledge this by specifying one of these capabilities.
*
*
* The following IAM resources require you to specify either the CAPABILITY_IAM or
* CAPABILITY_NAMED_IAM capability.
*
*
* -
*
* If you have IAM resources, you can specify either capability.
*
*
* -
*
* If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
*
*
* -
*
* If you don't specify either of these capabilities, AWS CloudFormation returns an
* InsufficientCapabilities error.
*
*
*
*
* If your stack template contains these resources, we recommend that you review all permissions associated
* with them and edit their permissions if necessary.
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
* AWS::IAM::Role
*
*
* -
*
*
* AWS::IAM::User
*
*
* -
*
*
*
*
* For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
*
*
* -
*
* CAPABILITY_AUTO_EXPAND
*
*
* Some template contain macros. Macros perform custom processing on templates; this can include simple
* actions like find-and-replace operations, all the way to extensive transformations of entire templates.
* Because of this, users typically create a change set from the processed template, so that they can review
* the changes resulting from the macros before actually creating the stack. If your stack template contains
* one or more macros, and you choose to create a stack directly from the processed template, without first
* reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the
* AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.
*
*
* Change sets do not currently support nested stacks. If you want to create a stack from a stack template
* that contains macros and nested stacks, you must create the stack directly from the template using
* this capability.
*
*
*
* You should only create stacks directly from a stack template that contains macros if you know what
* processing the macro performs.
*
*
* Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that
* the Lambda function owner can update the function operation without AWS CloudFormation being notified.
*
*
*
* For more information, see Using AWS
* CloudFormation Macros to Perform Custom Processing on Templates.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see Capability
*/
public CreateStackRequest withCapabilities(Capability... capabilities) {
com.amazonaws.internal.SdkInternalList capabilitiesCopy = new com.amazonaws.internal.SdkInternalList(capabilities.length);
for (Capability value : capabilities) {
capabilitiesCopy.add(value.toString());
}
if (getCapabilities() == null) {
setCapabilities(capabilitiesCopy);
} else {
getCapabilities().addAll(capabilitiesCopy);
}
return this;
}
/**
*
* The template resource types that you have permissions to work with for this create stack action, such as
* AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. Use the
* following syntax to describe template resource types: AWS::* (for all AWS resource),
* Custom::* (for all custom resources), Custom::logical_ID (for a specific custom
* resource), AWS::service_name::* (for all resources of a particular AWS service), and
* AWS::service_name::resource_logical_ID (for a specific AWS resource).
*
*
* If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By
* default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM)
* uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access
* with AWS Identity and Access Management.
*
*
* @return The template resource types that you have permissions to work with for this create stack action, such as
* AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. Use
* the following syntax to describe template resource types: AWS::* (for all AWS resource),
* Custom::* (for all custom resources), Custom::logical_ID (for a
* specific custom resource), AWS::service_name::* (for all resources of a particular
* AWS service), and AWS::service_name::resource_logical_ID (for a specific AWS
* resource).
*
* If the list of resource types doesn't include a resource that you're creating, the stack creation fails.
* By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access
* Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For
* more information, see Controlling
* Access with AWS Identity and Access Management.
*/
public java.util.List getResourceTypes() {
if (resourceTypes == null) {
resourceTypes = new com.amazonaws.internal.SdkInternalList();
}
return resourceTypes;
}
/**
*
* The template resource types that you have permissions to work with for this create stack action, such as
* AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. Use the
* following syntax to describe template resource types: AWS::* (for all AWS resource),
* Custom::* (for all custom resources), Custom::logical_ID (for a specific custom
* resource), AWS::service_name::* (for all resources of a particular AWS service), and
* AWS::service_name::resource_logical_ID (for a specific AWS resource).
*
*
* If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By
* default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM)
* uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access
* with AWS Identity and Access Management.
*
*
* @param resourceTypes
* The template resource types that you have permissions to work with for this create stack action, such as
* AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. Use
* the following syntax to describe template resource types: AWS::* (for all AWS resource),
* Custom::* (for all custom resources), Custom::logical_ID (for a specific
* custom resource), AWS::service_name::* (for all resources of a particular AWS
* service), and AWS::service_name::resource_logical_ID (for a specific AWS
* resource).
*
* If the list of resource types doesn't include a resource that you're creating, the stack creation fails.
* By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access
* Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For
* more information, see Controlling
* Access with AWS Identity and Access Management.
*/
public void setResourceTypes(java.util.Collection resourceTypes) {
if (resourceTypes == null) {
this.resourceTypes = null;
return;
}
this.resourceTypes = new com.amazonaws.internal.SdkInternalList(resourceTypes);
}
/**
*
* The template resource types that you have permissions to work with for this create stack action, such as
* AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. Use the
* following syntax to describe template resource types: AWS::* (for all AWS resource),
* Custom::* (for all custom resources), Custom::logical_ID (for a specific custom
* resource), AWS::service_name::* (for all resources of a particular AWS service), and
* AWS::service_name::resource_logical_ID (for a specific AWS resource).
*
*
* If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By
* default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM)
* uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access
* with AWS Identity and Access Management.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setResourceTypes(java.util.Collection)} or {@link #withResourceTypes(java.util.Collection)} if you want
* to override the existing values.
*
*
* @param resourceTypes
* The template resource types that you have permissions to work with for this create stack action, such as
* AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. Use
* the following syntax to describe template resource types: AWS::* (for all AWS resource),
* Custom::* (for all custom resources), Custom::logical_ID (for a specific
* custom resource), AWS::service_name::* (for all resources of a particular AWS
* service), and AWS::service_name::resource_logical_ID (for a specific AWS
* resource).
*
* If the list of resource types doesn't include a resource that you're creating, the stack creation fails.
* By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access
* Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For
* more information, see Controlling
* Access with AWS Identity and Access Management.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateStackRequest withResourceTypes(String... resourceTypes) {
if (this.resourceTypes == null) {
setResourceTypes(new com.amazonaws.internal.SdkInternalList(resourceTypes.length));
}
for (String ele : resourceTypes) {
this.resourceTypes.add(ele);
}
return this;
}
/**
*
* The template resource types that you have permissions to work with for this create stack action, such as
* AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. Use the
* following syntax to describe template resource types: AWS::* (for all AWS resource),
* Custom::* (for all custom resources), Custom::logical_ID (for a specific custom
* resource), AWS::service_name::* (for all resources of a particular AWS service), and
* AWS::service_name::resource_logical_ID (for a specific AWS resource).
*
*
* If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By
* default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM)
* uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access
* with AWS Identity and Access Management.
*
*
* @param resourceTypes
* The template resource types that you have permissions to work with for this create stack action, such as
* AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. Use
* the following syntax to describe template resource types: AWS::* (for all AWS resource),
* Custom::* (for all custom resources), Custom::logical_ID (for a specific
* custom resource), AWS::service_name::* (for all resources of a particular AWS
* service), and AWS::service_name::resource_logical_ID (for a specific AWS
* resource).
*
* If the list of resource types doesn't include a resource that you're creating, the stack creation fails.
* By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access
* Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For
* more information, see Controlling
* Access with AWS Identity and Access Management.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateStackRequest withResourceTypes(java.util.Collection resourceTypes) {
setResourceTypes(resourceTypes);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation
* assumes to create the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS
* CloudFormation always uses this role for all future operations on the stack. As long as users have permission to
* operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it.
* Ensure that the role grants least privilege.
*
*
* If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If
* no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.
*
*
* @param roleARN
* The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation
* assumes to create the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf.
* AWS CloudFormation always uses this role for all future operations on the stack. As long as users have
* permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have
* permission to pass it. Ensure that the role grants least privilege.
*
* If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the
* stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your
* user credentials.
*/
public void setRoleARN(String roleARN) {
this.roleARN = roleARN;
}
/**
*
* The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation
* assumes to create the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS
* CloudFormation always uses this role for all future operations on the stack. As long as users have permission to
* operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it.
* Ensure that the role grants least privilege.
*
*
* If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If
* no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.
*
*
* @return The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS
* CloudFormation assumes to create the stack. AWS CloudFormation uses the role's credentials to make calls
* on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long
* as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users
* don't have permission to pass it. Ensure that the role grants least privilege.
*
* If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the
* stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your
* user credentials.
*/
public String getRoleARN() {
return this.roleARN;
}
/**
*
* The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation
* assumes to create the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS
* CloudFormation always uses this role for all future operations on the stack. As long as users have permission to
* operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it.
* Ensure that the role grants least privilege.
*
*
* If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If
* no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.
*
*
* @param roleARN
* The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation
* assumes to create the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf.
* AWS CloudFormation always uses this role for all future operations on the stack. As long as users have
* permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have
* permission to pass it. Ensure that the role grants least privilege.
*
* If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the
* stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your
* user credentials.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateStackRequest withRoleARN(String roleARN) {
setRoleARN(roleARN);
return this;
}
/**
*
* Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or
* DELETE. You can specify either OnFailure or DisableRollback, but not both.
*
*
* Default: ROLLBACK
*
*
* @param onFailure
* Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK,
* or DELETE. You can specify either OnFailure or DisableRollback, but not
* both.
*
* Default: ROLLBACK
* @see OnFailure
*/
public void setOnFailure(String onFailure) {
this.onFailure = onFailure;
}
/**
*
* Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or
* DELETE. You can specify either OnFailure or DisableRollback, but not both.
*
*
* Default: ROLLBACK
*
*
* @return Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK,
* or DELETE. You can specify either OnFailure or DisableRollback, but not
* both.
*
* Default: ROLLBACK
* @see OnFailure
*/
public String getOnFailure() {
return this.onFailure;
}
/**
*
* Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or
* DELETE. You can specify either OnFailure or DisableRollback, but not both.
*
*
* Default: ROLLBACK
*
*
* @param onFailure
* Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK,
* or DELETE. You can specify either OnFailure or DisableRollback, but not
* both.
*
* Default: ROLLBACK
* @return Returns a reference to this object so that method calls can be chained together.
* @see OnFailure
*/
public CreateStackRequest withOnFailure(String onFailure) {
setOnFailure(onFailure);
return this;
}
/**
*
* Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or
* DELETE. You can specify either OnFailure or DisableRollback, but not both.
*
*
* Default: ROLLBACK
*
*
* @param onFailure
* Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK,
* or DELETE. You can specify either OnFailure or DisableRollback, but not
* both.
*
* Default: ROLLBACK
* @see OnFailure
*/
public void setOnFailure(OnFailure onFailure) {
withOnFailure(onFailure);
}
/**
*
* Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or
* DELETE. You can specify either OnFailure or DisableRollback, but not both.
*
*
* Default: ROLLBACK
*
*
* @param onFailure
* Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK,
* or DELETE. You can specify either OnFailure or DisableRollback, but not
* both.
*
* Default: ROLLBACK
* @return Returns a reference to this object so that method calls can be chained together.
* @see OnFailure
*/
public CreateStackRequest withOnFailure(OnFailure onFailure) {
this.onFailure = onFailure.toString();
return this;
}
/**
*
* Structure containing the stack policy body. For more information, go to Prevent
* Updates to Stack Resources in the AWS CloudFormation User Guide. You can specify either the
* StackPolicyBody or the StackPolicyURL parameter, but not both.
*
*
* @param stackPolicyBody
* Structure containing the stack policy body. For more information, go to Prevent
* Updates to Stack Resources in the AWS CloudFormation User Guide. You can specify either the
* StackPolicyBody or the StackPolicyURL parameter, but not both.
*/
public void setStackPolicyBody(String stackPolicyBody) {
this.stackPolicyBody = stackPolicyBody;
}
/**
*
* Structure containing the stack policy body. For more information, go to Prevent
* Updates to Stack Resources in the AWS CloudFormation User Guide. You can specify either the
* StackPolicyBody or the StackPolicyURL parameter, but not both.
*
*
* @return Structure containing the stack policy body. For more information, go to
* Prevent Updates to Stack Resources in the AWS CloudFormation User Guide. You can specify
* either the StackPolicyBody or the StackPolicyURL parameter, but not both.
*/
public String getStackPolicyBody() {
return this.stackPolicyBody;
}
/**
*
* Structure containing the stack policy body. For more information, go to Prevent
* Updates to Stack Resources in the AWS CloudFormation User Guide. You can specify either the
* StackPolicyBody or the StackPolicyURL parameter, but not both.
*
*
* @param stackPolicyBody
* Structure containing the stack policy body. For more information, go to Prevent
* Updates to Stack Resources in the AWS CloudFormation User Guide. You can specify either the
* StackPolicyBody or the StackPolicyURL parameter, but not both.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateStackRequest withStackPolicyBody(String stackPolicyBody) {
setStackPolicyBody(stackPolicyBody);
return this;
}
/**
*
* Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in
* an S3 bucket in the same region as the stack. You can specify either the StackPolicyBody or the
* StackPolicyURL parameter, but not both.
*
*
* @param stackPolicyURL
* Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB)
* located in an S3 bucket in the same region as the stack. You can specify either the
* StackPolicyBody or the StackPolicyURL parameter, but not both.
*/
public void setStackPolicyURL(String stackPolicyURL) {
this.stackPolicyURL = stackPolicyURL;
}
/**
*
* Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in
* an S3 bucket in the same region as the stack. You can specify either the StackPolicyBody or the
* StackPolicyURL parameter, but not both.
*
*
* @return Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB)
* located in an S3 bucket in the same region as the stack. You can specify either the
* StackPolicyBody or the StackPolicyURL parameter, but not both.
*/
public String getStackPolicyURL() {
return this.stackPolicyURL;
}
/**
*
* Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in
* an S3 bucket in the same region as the stack. You can specify either the StackPolicyBody or the
* StackPolicyURL parameter, but not both.
*
*
* @param stackPolicyURL
* Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB)
* located in an S3 bucket in the same region as the stack. You can specify either the
* StackPolicyBody or the StackPolicyURL parameter, but not both.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateStackRequest withStackPolicyURL(String stackPolicyURL) {
setStackPolicyURL(stackPolicyURL);
return this;
}
/**
*
* Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to the resources
* created in the stack. A maximum number of 50 tags can be specified.
*
*
* @return Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to the
* resources created in the stack. A maximum number of 50 tags can be specified.
*/
public java.util.List getTags() {
if (tags == null) {
tags = new com.amazonaws.internal.SdkInternalList();
}
return tags;
}
/**
*
* Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to the resources
* created in the stack. A maximum number of 50 tags can be specified.
*
*
* @param tags
* Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to the
* resources created in the stack. A maximum number of 50 tags can be specified.
*/
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. AWS CloudFormation also propagates these tags to the resources
* created in the stack. A maximum number of 50 tags can be specified.
*
*
* 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. AWS CloudFormation also propagates these tags to the
* resources created in the stack. A maximum number of 50 tags can be specified.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateStackRequest 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. AWS CloudFormation also propagates these tags to the resources
* created in the stack. A maximum number of 50 tags can be specified.
*
*
* @param tags
* Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to the
* resources created in the stack. A maximum number of 50 tags can be specified.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateStackRequest withTags(java.util.Collection tags) {
setTags(tags);
return this;
}
/**
*
* A unique identifier for this CreateStack request. Specify this token if you plan to retry requests
* so that AWS CloudFormation knows that you're not attempting to create a stack with the same name. You might retry
* CreateStack requests to ensure that AWS CloudFormation successfully received them.
*
*
* All events triggered by a given stack operation are assigned the same client request token, which you can use to
* track operations. For example, if you execute a CreateStack operation with the token
* token1, then all the StackEvents generated by that operation will have
* ClientRequestToken set as token1.
*
*
* In the console, stack operations display the client request token on the Events tab. Stack operations that are
* initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify
* the stack operation . For example, if you create a stack using the console, each stack event would be assigned
* the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
*
*
* @param clientRequestToken
* A unique identifier for this CreateStack request. Specify this token if you plan to retry
* requests so that AWS CloudFormation knows that you're not attempting to create a stack with the same name.
* You might retry CreateStack requests to ensure that AWS CloudFormation successfully received
* them.
*
* All events triggered by a given stack operation are assigned the same client request token, which you can
* use to track operations. For example, if you execute a CreateStack operation with the token
* token1, then all the StackEvents generated by that operation will have
* ClientRequestToken set as token1.
*
*
* In the console, stack operations display the client request token on the Events tab. Stack operations that
* are initiated from the console use the token format Console-StackOperation-ID, which helps you
* easily identify the stack operation . For example, if you create a stack using the console, each stack
* event would be assigned the same token in the following format:
* Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
*/
public void setClientRequestToken(String clientRequestToken) {
this.clientRequestToken = clientRequestToken;
}
/**
*
* A unique identifier for this CreateStack request. Specify this token if you plan to retry requests
* so that AWS CloudFormation knows that you're not attempting to create a stack with the same name. You might retry
* CreateStack requests to ensure that AWS CloudFormation successfully received them.
*
*
* All events triggered by a given stack operation are assigned the same client request token, which you can use to
* track operations. For example, if you execute a CreateStack operation with the token
* token1, then all the StackEvents generated by that operation will have
* ClientRequestToken set as token1.
*
*
* In the console, stack operations display the client request token on the Events tab. Stack operations that are
* initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify
* the stack operation . For example, if you create a stack using the console, each stack event would be assigned
* the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
*
*
* @return A unique identifier for this CreateStack request. Specify this token if you plan to retry
* requests so that AWS CloudFormation knows that you're not attempting to create a stack with the same
* name. You might retry CreateStack requests to ensure that AWS CloudFormation successfully
* received them.
*
* All events triggered by a given stack operation are assigned the same client request token, which you can
* use to track operations. For example, if you execute a CreateStack operation with the token
* token1, then all the StackEvents generated by that operation will have
* ClientRequestToken set as token1.
*
*
* In the console, stack operations display the client request token on the Events tab. Stack operations
* that are initiated from the console use the token format Console-StackOperation-ID, which helps
* you easily identify the stack operation . For example, if you create a stack using the console, each
* stack event would be assigned the same token in the following format:
* Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
*/
public String getClientRequestToken() {
return this.clientRequestToken;
}
/**
*
* A unique identifier for this CreateStack request. Specify this token if you plan to retry requests
* so that AWS CloudFormation knows that you're not attempting to create a stack with the same name. You might retry
* CreateStack requests to ensure that AWS CloudFormation successfully received them.
*
*
* All events triggered by a given stack operation are assigned the same client request token, which you can use to
* track operations. For example, if you execute a CreateStack operation with the token
* token1, then all the StackEvents generated by that operation will have
* ClientRequestToken set as token1.
*
*
* In the console, stack operations display the client request token on the Events tab. Stack operations that are
* initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify
* the stack operation . For example, if you create a stack using the console, each stack event would be assigned
* the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
*
*
* @param clientRequestToken
* A unique identifier for this CreateStack request. Specify this token if you plan to retry
* requests so that AWS CloudFormation knows that you're not attempting to create a stack with the same name.
* You might retry CreateStack requests to ensure that AWS CloudFormation successfully received
* them.
*
* All events triggered by a given stack operation are assigned the same client request token, which you can
* use to track operations. For example, if you execute a CreateStack operation with the token
* token1, then all the StackEvents generated by that operation will have
* ClientRequestToken set as token1.
*
*
* In the console, stack operations display the client request token on the Events tab. Stack operations that
* are initiated from the console use the token format Console-StackOperation-ID, which helps you
* easily identify the stack operation . For example, if you create a stack using the console, each stack
* event would be assigned the same token in the following format:
* Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateStackRequest withClientRequestToken(String clientRequestToken) {
setClientRequestToken(clientRequestToken);
return this;
}
/**
*
* Whether to enable termination protection on the specified stack. If a user attempts to delete a stack with
* termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a
* Stack From Being Deleted in the AWS CloudFormation User Guide. Termination protection is disabled on
* stacks by default.
*
*
* For nested
* stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack.
*
*
* @param enableTerminationProtection
* Whether to enable termination protection on the specified stack. If a user attempts to delete a stack with
* termination protection enabled, the operation fails and the stack remains unchanged. For more information,
* see
* Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide. Termination
* protection is disabled on stacks by default.
*
* For nested
* stacks, termination protection is set on the root stack and cannot be changed directly on the nested
* stack.
*/
public void setEnableTerminationProtection(Boolean enableTerminationProtection) {
this.enableTerminationProtection = enableTerminationProtection;
}
/**
*
* Whether to enable termination protection on the specified stack. If a user attempts to delete a stack with
* termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a
* Stack From Being Deleted in the AWS CloudFormation User Guide. Termination protection is disabled on
* stacks by default.
*
*
* For nested
* stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack.
*
*
* @return Whether to enable termination protection on the specified stack. If a user attempts to delete a stack
* with termination protection enabled, the operation fails and the stack remains unchanged. For more
* information, see Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide. Termination
* protection is disabled on stacks by default.
*
* For
* nested stacks, termination protection is set on the root stack and cannot be changed directly on the
* nested stack.
*/
public Boolean getEnableTerminationProtection() {
return this.enableTerminationProtection;
}
/**
*
* Whether to enable termination protection on the specified stack. If a user attempts to delete a stack with
* termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a
* Stack From Being Deleted in the AWS CloudFormation User Guide. Termination protection is disabled on
* stacks by default.
*
*
* For nested
* stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack.
*
*
* @param enableTerminationProtection
* Whether to enable termination protection on the specified stack. If a user attempts to delete a stack with
* termination protection enabled, the operation fails and the stack remains unchanged. For more information,
* see
* Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide. Termination
* protection is disabled on stacks by default.
*
* For nested
* stacks, termination protection is set on the root stack and cannot be changed directly on the nested
* stack.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateStackRequest withEnableTerminationProtection(Boolean enableTerminationProtection) {
setEnableTerminationProtection(enableTerminationProtection);
return this;
}
/**
*
* Whether to enable termination protection on the specified stack. If a user attempts to delete a stack with
* termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a
* Stack From Being Deleted in the AWS CloudFormation User Guide. Termination protection is disabled on
* stacks by default.
*
*
* For nested
* stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack.
*
*
* @return Whether to enable termination protection on the specified stack. If a user attempts to delete a stack
* with termination protection enabled, the operation fails and the stack remains unchanged. For more
* information, see Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide. Termination
* protection is disabled on stacks by default.
*
* For
* nested stacks, termination protection is set on the root stack and cannot be changed directly on the
* nested stack.
*/
public Boolean isEnableTerminationProtection() {
return this.enableTerminationProtection;
}
/**
* 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 (getParameters() != null)
sb.append("Parameters: ").append(getParameters()).append(",");
if (getDisableRollback() != null)
sb.append("DisableRollback: ").append(getDisableRollback()).append(",");
if (getRollbackConfiguration() != null)
sb.append("RollbackConfiguration: ").append(getRollbackConfiguration()).append(",");
if (getTimeoutInMinutes() != null)
sb.append("TimeoutInMinutes: ").append(getTimeoutInMinutes()).append(",");
if (getNotificationARNs() != null)
sb.append("NotificationARNs: ").append(getNotificationARNs()).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 (getOnFailure() != null)
sb.append("OnFailure: ").append(getOnFailure()).append(",");
if (getStackPolicyBody() != null)
sb.append("StackPolicyBody: ").append(getStackPolicyBody()).append(",");
if (getStackPolicyURL() != null)
sb.append("StackPolicyURL: ").append(getStackPolicyURL()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags()).append(",");
if (getClientRequestToken() != null)
sb.append("ClientRequestToken: ").append(getClientRequestToken()).append(",");
if (getEnableTerminationProtection() != null)
sb.append("EnableTerminationProtection: ").append(getEnableTerminationProtection());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateStackRequest == false)
return false;
CreateStackRequest other = (CreateStackRequest) 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.getParameters() == null ^ this.getParameters() == null)
return false;
if (other.getParameters() != null && other.getParameters().equals(this.getParameters()) == false)
return false;
if (other.getDisableRollback() == null ^ this.getDisableRollback() == null)
return false;
if (other.getDisableRollback() != null && other.getDisableRollback().equals(this.getDisableRollback()) == false)
return false;
if (other.getRollbackConfiguration() == null ^ this.getRollbackConfiguration() == null)
return false;
if (other.getRollbackConfiguration() != null && other.getRollbackConfiguration().equals(this.getRollbackConfiguration()) == false)
return false;
if (other.getTimeoutInMinutes() == null ^ this.getTimeoutInMinutes() == null)
return false;
if (other.getTimeoutInMinutes() != null && other.getTimeoutInMinutes().equals(this.getTimeoutInMinutes()) == 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.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.getOnFailure() == null ^ this.getOnFailure() == null)
return false;
if (other.getOnFailure() != null && other.getOnFailure().equals(this.getOnFailure()) == false)
return false;
if (other.getStackPolicyBody() == null ^ this.getStackPolicyBody() == null)
return false;
if (other.getStackPolicyBody() != null && other.getStackPolicyBody().equals(this.getStackPolicyBody()) == false)
return false;
if (other.getStackPolicyURL() == null ^ this.getStackPolicyURL() == null)
return false;
if (other.getStackPolicyURL() != null && other.getStackPolicyURL().equals(this.getStackPolicyURL()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
if (other.getClientRequestToken() == null ^ this.getClientRequestToken() == null)
return false;
if (other.getClientRequestToken() != null && other.getClientRequestToken().equals(this.getClientRequestToken()) == false)
return false;
if (other.getEnableTerminationProtection() == null ^ this.getEnableTerminationProtection() == null)
return false;
if (other.getEnableTerminationProtection() != null && other.getEnableTerminationProtection().equals(this.getEnableTerminationProtection()) == 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 + ((getParameters() == null) ? 0 : getParameters().hashCode());
hashCode = prime * hashCode + ((getDisableRollback() == null) ? 0 : getDisableRollback().hashCode());
hashCode = prime * hashCode + ((getRollbackConfiguration() == null) ? 0 : getRollbackConfiguration().hashCode());
hashCode = prime * hashCode + ((getTimeoutInMinutes() == null) ? 0 : getTimeoutInMinutes().hashCode());
hashCode = prime * hashCode + ((getNotificationARNs() == null) ? 0 : getNotificationARNs().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 + ((getOnFailure() == null) ? 0 : getOnFailure().hashCode());
hashCode = prime * hashCode + ((getStackPolicyBody() == null) ? 0 : getStackPolicyBody().hashCode());
hashCode = prime * hashCode + ((getStackPolicyURL() == null) ? 0 : getStackPolicyURL().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
hashCode = prime * hashCode + ((getClientRequestToken() == null) ? 0 : getClientRequestToken().hashCode());
hashCode = prime * hashCode + ((getEnableTerminationProtection() == null) ? 0 : getEnableTerminationProtection().hashCode());
return hashCode;
}
@Override
public CreateStackRequest clone() {
return (CreateStackRequest) super.clone();
}
}