Class CreateStackRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.cloudformation.model.CreateStackRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class CreateStackRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
The input for CreateStack action.
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description CreateStackRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CreateStackRequest
clone()
Creates a shallow clone of this request.boolean
equals(Object obj)
List<String>
getCapabilities()
A list of capabilities that you must specify before AWS CloudFormation can create certain stacks.Boolean
getDisableRollback()
Set totrue
to disable rollback of the stack if stack creation failed.List<String>
getNotificationARNs()
The Simple Notification Service (SNS) topic ARNs to publish stack related events.String
getOnFailure()
Determines what action will be taken if stack creation fails.List<Parameter>
getParameters()
A list ofParameter
structures that specify input parameters for the stack.List<String>
getResourceTypes()
The template resource types that you have permissions to work with for this create stack action, such asAWS::EC2::Instance
,AWS::EC2::*
, orCustom::MyCustomInstance
.String
getStackName()
The name that is associated with the stack.String
getStackPolicyBody()
Structure containing the stack policy body.String
getStackPolicyURL()
Location of a file containing the stack policy.List<Tag>
getTags()
Key-value pairs to associate with this stack.String
getTemplateBody()
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.String
getTemplateURL()
Location of file containing the template body.Integer
getTimeoutInMinutes()
The amount of time that can pass before the stack status becomes CREATE_FAILED; ifDisableRollback
is not set or is set tofalse
, the stack will be rolled back.int
hashCode()
Boolean
isDisableRollback()
Set totrue
to disable rollback of the stack if stack creation failed.void
setCapabilities(Collection<String> capabilities)
A list of capabilities that you must specify before AWS CloudFormation can create certain stacks.void
setDisableRollback(Boolean disableRollback)
Set totrue
to disable rollback of the stack if stack creation failed.void
setNotificationARNs(Collection<String> notificationARNs)
The Simple Notification Service (SNS) topic ARNs to publish stack related events.void
setOnFailure(OnFailure onFailure)
Determines what action will be taken if stack creation fails.void
setOnFailure(String onFailure)
Determines what action will be taken if stack creation fails.void
setParameters(Collection<Parameter> parameters)
A list ofParameter
structures that specify input parameters for the stack.void
setResourceTypes(Collection<String> resourceTypes)
The template resource types that you have permissions to work with for this create stack action, such asAWS::EC2::Instance
,AWS::EC2::*
, orCustom::MyCustomInstance
.void
setStackName(String stackName)
The name that is associated with the stack.void
setStackPolicyBody(String stackPolicyBody)
Structure containing the stack policy body.void
setStackPolicyURL(String stackPolicyURL)
Location of a file containing the stack policy.void
setTags(Collection<Tag> tags)
Key-value pairs to associate with this stack.void
setTemplateBody(String templateBody)
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.void
setTemplateURL(String templateURL)
Location of file containing the template body.void
setTimeoutInMinutes(Integer timeoutInMinutes)
The amount of time that can pass before the stack status becomes CREATE_FAILED; ifDisableRollback
is not set or is set tofalse
, the stack will be rolled back.String
toString()
Returns a string representation of this object; useful for testing and debugging.CreateStackRequest
withCapabilities(Capability... capabilities)
A list of capabilities that you must specify before AWS CloudFormation can create certain stacks.CreateStackRequest
withCapabilities(String... capabilities)
A list of capabilities that you must specify before AWS CloudFormation can create certain stacks.CreateStackRequest
withCapabilities(Collection<String> capabilities)
A list of capabilities that you must specify before AWS CloudFormation can create certain stacks.CreateStackRequest
withDisableRollback(Boolean disableRollback)
Set totrue
to disable rollback of the stack if stack creation failed.CreateStackRequest
withNotificationARNs(String... notificationARNs)
The Simple Notification Service (SNS) topic ARNs to publish stack related events.CreateStackRequest
withNotificationARNs(Collection<String> notificationARNs)
The Simple Notification Service (SNS) topic ARNs to publish stack related events.CreateStackRequest
withOnFailure(OnFailure onFailure)
Determines what action will be taken if stack creation fails.CreateStackRequest
withOnFailure(String onFailure)
Determines what action will be taken if stack creation fails.CreateStackRequest
withParameters(Parameter... parameters)
A list ofParameter
structures that specify input parameters for the stack.CreateStackRequest
withParameters(Collection<Parameter> parameters)
A list ofParameter
structures that specify input parameters for the stack.CreateStackRequest
withResourceTypes(String... resourceTypes)
The template resource types that you have permissions to work with for this create stack action, such asAWS::EC2::Instance
,AWS::EC2::*
, orCustom::MyCustomInstance
.CreateStackRequest
withResourceTypes(Collection<String> resourceTypes)
The template resource types that you have permissions to work with for this create stack action, such asAWS::EC2::Instance
,AWS::EC2::*
, orCustom::MyCustomInstance
.CreateStackRequest
withStackName(String stackName)
The name that is associated with the stack.CreateStackRequest
withStackPolicyBody(String stackPolicyBody)
Structure containing the stack policy body.CreateStackRequest
withStackPolicyURL(String stackPolicyURL)
Location of a file containing the stack policy.CreateStackRequest
withTags(Tag... tags)
Key-value pairs to associate with this stack.CreateStackRequest
withTags(Collection<Tag> tags)
Key-value pairs to associate with this stack.CreateStackRequest
withTemplateBody(String templateBody)
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.CreateStackRequest
withTemplateURL(String templateURL)
Location of file containing the template body.CreateStackRequest
withTimeoutInMinutes(Integer timeoutInMinutes)
The amount of time that can pass before the stack status becomes CREATE_FAILED; ifDisableRollback
is not set or is set tofalse
, the stack will be rolled back.-
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
Method Detail
-
setStackName
public void setStackName(String 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.
- Parameters:
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.
-
getStackName
public String getStackName()
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.
- Returns:
- 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.
-
withStackName
public CreateStackRequest withStackName(String 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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setTemplateBody
public void setTemplateBody(String templateBody)
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must specify either the
TemplateBody
or theTemplateURL
parameter, but not both.- Parameters:
templateBody
- Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.Conditional: You must specify either the
TemplateBody
or theTemplateURL
parameter, but not both.
-
getTemplateBody
public String getTemplateBody()
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 theTemplateURL
parameter, but not both.- Returns:
- 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 theTemplateURL
parameter, but not both.
-
withTemplateBody
public CreateStackRequest withTemplateBody(String templateBody)
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must specify either the
TemplateBody
or theTemplateURL
parameter, but not both.- Parameters:
templateBody
- Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.Conditional: You must specify either the
TemplateBody
or theTemplateURL
parameter, but not both.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setTemplateURL
public void setTemplateURL(String 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 theTemplateURL
parameter, but not both.- Parameters:
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 theTemplateURL
parameter, but not both.
-
getTemplateURL
public String getTemplateURL()
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 theTemplateURL
parameter, but not both.- Returns:
- 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 theTemplateURL
parameter, but not both.
-
withTemplateURL
public CreateStackRequest withTemplateURL(String 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 theTemplateURL
parameter, but not both.- Parameters:
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 theTemplateURL
parameter, but not both.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getParameters
public List<Parameter> getParameters()
A list of
Parameter
structures that specify input parameters for the stack. For more information, see the Parameter data type.- Returns:
- A list of
Parameter
structures that specify input parameters for the stack. For more information, see the Parameter data type.
-
setParameters
public void setParameters(Collection<Parameter> parameters)
A list of
Parameter
structures that specify input parameters for the stack. For more information, see the Parameter data type.- Parameters:
parameters
- A list ofParameter
structures that specify input parameters for the stack. For more information, see the Parameter data type.
-
withParameters
public CreateStackRequest withParameters(Parameter... 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
setParameters(java.util.Collection)
orwithParameters(java.util.Collection)
if you want to override the existing values.- Parameters:
parameters
- A list ofParameter
structures that specify input parameters for the stack. For more information, see the Parameter data type.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withParameters
public CreateStackRequest withParameters(Collection<Parameter> parameters)
A list of
Parameter
structures that specify input parameters for the stack. For more information, see the Parameter data type.- Parameters:
parameters
- A list ofParameter
structures that specify input parameters for the stack. For more information, see the Parameter data type.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDisableRollback
public void setDisableRollback(Boolean disableRollback)
Set to
true
to disable rollback of the stack if stack creation failed. You can specify eitherDisableRollback
orOnFailure
, but not both.Default:
false
- Parameters:
disableRollback
- Set totrue
to disable rollback of the stack if stack creation failed. You can specify eitherDisableRollback
orOnFailure
, but not both.Default:
false
-
getDisableRollback
public Boolean getDisableRollback()
Set to
true
to disable rollback of the stack if stack creation failed. You can specify eitherDisableRollback
orOnFailure
, but not both.Default:
false
- Returns:
- Set to
true
to disable rollback of the stack if stack creation failed. You can specify eitherDisableRollback
orOnFailure
, but not both.Default:
false
-
withDisableRollback
public CreateStackRequest withDisableRollback(Boolean disableRollback)
Set to
true
to disable rollback of the stack if stack creation failed. You can specify eitherDisableRollback
orOnFailure
, but not both.Default:
false
- Parameters:
disableRollback
- Set totrue
to disable rollback of the stack if stack creation failed. You can specify eitherDisableRollback
orOnFailure
, but not both.Default:
false
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isDisableRollback
public Boolean isDisableRollback()
Set to
true
to disable rollback of the stack if stack creation failed. You can specify eitherDisableRollback
orOnFailure
, but not both.Default:
false
- Returns:
- Set to
true
to disable rollback of the stack if stack creation failed. You can specify eitherDisableRollback
orOnFailure
, but not both.Default:
false
-
setTimeoutInMinutes
public void setTimeoutInMinutes(Integer timeoutInMinutes)
The amount of time that can pass before the stack status becomes CREATE_FAILED; if
DisableRollback
is not set or is set tofalse
, the stack will be rolled back.- Parameters:
timeoutInMinutes
- The amount of time that can pass before the stack status becomes CREATE_FAILED; ifDisableRollback
is not set or is set tofalse
, the stack will be rolled back.
-
getTimeoutInMinutes
public Integer getTimeoutInMinutes()
The amount of time that can pass before the stack status becomes CREATE_FAILED; if
DisableRollback
is not set or is set tofalse
, the stack will be rolled back.- Returns:
- The amount of time that can pass before the stack status becomes
CREATE_FAILED; if
DisableRollback
is not set or is set tofalse
, the stack will be rolled back.
-
withTimeoutInMinutes
public CreateStackRequest withTimeoutInMinutes(Integer timeoutInMinutes)
The amount of time that can pass before the stack status becomes CREATE_FAILED; if
DisableRollback
is not set or is set tofalse
, the stack will be rolled back.- Parameters:
timeoutInMinutes
- The amount of time that can pass before the stack status becomes CREATE_FAILED; ifDisableRollback
is not set or is set tofalse
, the stack will be rolled back.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getNotificationARNs
public List<String> getNotificationARNs()
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).
- Returns:
- 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).
-
setNotificationARNs
public void setNotificationARNs(Collection<String> 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).
- Parameters:
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).
-
withNotificationARNs
public CreateStackRequest withNotificationARNs(String... 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
setNotificationARNs(java.util.Collection)
orwithNotificationARNs(java.util.Collection)
if you want to override the existing values.- Parameters:
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).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withNotificationARNs
public CreateStackRequest withNotificationARNs(Collection<String> 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).
- Parameters:
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).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getCapabilities
public List<String> getCapabilities()
A list of capabilities that you must specify before AWS CloudFormation can create certain stacks. 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 their capabilities by specifying this parameter.
Currently, the only valid value is
CAPABILITY_IAM
, which is required for the following resources: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. If your template contains any of the listed resources and you don't specify this parameter, this action returns anInsufficientCapabilities
error.- Returns:
- A list of capabilities that you must specify before AWS
CloudFormation can create certain stacks. 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 their capabilities by specifying this parameter.
Currently, the only valid value is
CAPABILITY_IAM
, which is required for the following resources: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. If your template contains any of the listed resources and you don't specify this parameter, this action returns anInsufficientCapabilities
error. - See Also:
Capability
-
setCapabilities
public void setCapabilities(Collection<String> capabilities)
A list of capabilities that you must specify before AWS CloudFormation can create certain stacks. 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 their capabilities by specifying this parameter.
Currently, the only valid value is
CAPABILITY_IAM
, which is required for the following resources: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. If your template contains any of the listed resources and you don't specify this parameter, this action returns anInsufficientCapabilities
error.- Parameters:
capabilities
- A list of capabilities that you must specify before AWS CloudFormation can create certain stacks. 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 their capabilities by specifying this parameter.Currently, the only valid value is
CAPABILITY_IAM
, which is required for the following resources: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. If your template contains any of the listed resources and you don't specify this parameter, this action returns anInsufficientCapabilities
error.- See Also:
Capability
-
withCapabilities
public CreateStackRequest withCapabilities(String... capabilities)
A list of capabilities that you must specify before AWS CloudFormation can create certain stacks. 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 their capabilities by specifying this parameter.
Currently, the only valid value is
CAPABILITY_IAM
, which is required for the following resources: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. If your template contains any of the listed resources and you don't specify this parameter, this action returns anInsufficientCapabilities
error.NOTE: This method appends the values to the existing list (if any). Use
setCapabilities(java.util.Collection)
orwithCapabilities(java.util.Collection)
if you want to override the existing values.- Parameters:
capabilities
- A list of capabilities that you must specify before AWS CloudFormation can create certain stacks. 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 their capabilities by specifying this parameter.Currently, the only valid value is
CAPABILITY_IAM
, which is required for the following resources: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. If your template contains any of the listed resources and you don't specify this parameter, this action returns anInsufficientCapabilities
error.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
Capability
-
withCapabilities
public CreateStackRequest withCapabilities(Collection<String> capabilities)
A list of capabilities that you must specify before AWS CloudFormation can create certain stacks. 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 their capabilities by specifying this parameter.
Currently, the only valid value is
CAPABILITY_IAM
, which is required for the following resources: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. If your template contains any of the listed resources and you don't specify this parameter, this action returns anInsufficientCapabilities
error.- Parameters:
capabilities
- A list of capabilities that you must specify before AWS CloudFormation can create certain stacks. 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 their capabilities by specifying this parameter.Currently, the only valid value is
CAPABILITY_IAM
, which is required for the following resources: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. If your template contains any of the listed resources and you don't specify this parameter, this action returns anInsufficientCapabilities
error.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
Capability
-
withCapabilities
public CreateStackRequest withCapabilities(Capability... capabilities)
A list of capabilities that you must specify before AWS CloudFormation can create certain stacks. 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 their capabilities by specifying this parameter.
Currently, the only valid value is
CAPABILITY_IAM
, which is required for the following resources: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. If your template contains any of the listed resources and you don't specify this parameter, this action returns anInsufficientCapabilities
error.- Parameters:
capabilities
- A list of capabilities that you must specify before AWS CloudFormation can create certain stacks. 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 their capabilities by specifying this parameter.Currently, the only valid value is
CAPABILITY_IAM
, which is required for the following resources: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. If your template contains any of the listed resources and you don't specify this parameter, this action returns anInsufficientCapabilities
error.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
Capability
-
getResourceTypes
public List<String> getResourceTypes()
The template resource types that you have permissions to work with for this create stack action, such as
AWS::EC2::Instance
,AWS::EC2::*
, orCustom::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), andAWS::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.
- Returns:
- The template resource types that you have permissions to work
with for this create stack action, such as
AWS::EC2::Instance
,AWS::EC2::*
, orCustom::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), andAWS::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.
-
setResourceTypes
public void setResourceTypes(Collection<String> resourceTypes)
The template resource types that you have permissions to work with for this create stack action, such as
AWS::EC2::Instance
,AWS::EC2::*
, orCustom::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), andAWS::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.
- Parameters:
resourceTypes
- The template resource types that you have permissions to work with for this create stack action, such asAWS::EC2::Instance
,AWS::EC2::*
, orCustom::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), andAWS::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.
-
withResourceTypes
public CreateStackRequest withResourceTypes(String... resourceTypes)
The template resource types that you have permissions to work with for this create stack action, such as
AWS::EC2::Instance
,AWS::EC2::*
, orCustom::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), andAWS::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
setResourceTypes(java.util.Collection)
orwithResourceTypes(java.util.Collection)
if you want to override the existing values.- Parameters:
resourceTypes
- The template resource types that you have permissions to work with for this create stack action, such asAWS::EC2::Instance
,AWS::EC2::*
, orCustom::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), andAWS::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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withResourceTypes
public CreateStackRequest withResourceTypes(Collection<String> resourceTypes)
The template resource types that you have permissions to work with for this create stack action, such as
AWS::EC2::Instance
,AWS::EC2::*
, orCustom::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), andAWS::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.
- Parameters:
resourceTypes
- The template resource types that you have permissions to work with for this create stack action, such asAWS::EC2::Instance
,AWS::EC2::*
, orCustom::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), andAWS::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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setOnFailure
public void setOnFailure(String 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
orDisableRollback
, but not both.Default:
ROLLBACK
- Parameters:
onFailure
- Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify eitherOnFailure
orDisableRollback
, but not both.Default:
ROLLBACK
- See Also:
OnFailure
-
getOnFailure
public String getOnFailure()
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
orDisableRollback
, but not both.Default:
ROLLBACK
- Returns:
- 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
orDisableRollback
, but not both.Default:
ROLLBACK
- See Also:
OnFailure
-
withOnFailure
public CreateStackRequest withOnFailure(String 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
orDisableRollback
, but not both.Default:
ROLLBACK
- Parameters:
onFailure
- Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify eitherOnFailure
orDisableRollback
, but not both.Default:
ROLLBACK
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
OnFailure
-
setOnFailure
public void setOnFailure(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
orDisableRollback
, but not both.Default:
ROLLBACK
- Parameters:
onFailure
- Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify eitherOnFailure
orDisableRollback
, but not both.Default:
ROLLBACK
- See Also:
OnFailure
-
withOnFailure
public CreateStackRequest withOnFailure(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
orDisableRollback
, but not both.Default:
ROLLBACK
- Parameters:
onFailure
- Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify eitherOnFailure
orDisableRollback
, but not both.Default:
ROLLBACK
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
OnFailure
-
setStackPolicyBody
public void setStackPolicyBody(String 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 theStackPolicyURL
parameter, but not both.- Parameters:
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 theStackPolicyBody
or theStackPolicyURL
parameter, but not both.
-
getStackPolicyBody
public String getStackPolicyBody()
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 theStackPolicyURL
parameter, but not both.- Returns:
- 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 theStackPolicyURL
parameter, but not both.
-
withStackPolicyBody
public CreateStackRequest withStackPolicyBody(String 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 theStackPolicyURL
parameter, but not both.- Parameters:
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 theStackPolicyBody
or theStackPolicyURL
parameter, but not both.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStackPolicyURL
public void setStackPolicyURL(String stackPolicyURL)
Location of a file containing the stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either the
StackPolicyBody
or theStackPolicyURL
parameter, but not both.- Parameters:
stackPolicyURL
- Location of a file containing the stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either theStackPolicyBody
or theStackPolicyURL
parameter, but not both.
-
getStackPolicyURL
public String getStackPolicyURL()
Location of a file containing the stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either the
StackPolicyBody
or theStackPolicyURL
parameter, but not both.- Returns:
- Location of a file containing the stack policy. The URL must
point to a policy (max size: 16KB) located in an S3 bucket in the
same region as the stack. You can specify either the
StackPolicyBody
or theStackPolicyURL
parameter, but not both.
-
withStackPolicyURL
public CreateStackRequest withStackPolicyURL(String stackPolicyURL)
Location of a file containing the stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either the
StackPolicyBody
or theStackPolicyURL
parameter, but not both.- Parameters:
stackPolicyURL
- Location of a file containing the stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either theStackPolicyBody
or theStackPolicyURL
parameter, but not both.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getTags
public List<Tag> getTags()
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 10 tags can be specified.
- Returns:
- 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 10 tags can be specified.
-
setTags
public void setTags(Collection<Tag> 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 10 tags can be specified.
- Parameters:
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 10 tags can be specified.
-
withTags
public CreateStackRequest withTags(Tag... 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 10 tags can be specified.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
orwithTags(java.util.Collection)
if you want to override the existing values.- Parameters:
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 10 tags can be specified.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withTags
public CreateStackRequest withTags(Collection<Tag> 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 10 tags can be specified.
- Parameters:
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 10 tags can be specified.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public CreateStackRequest clone()
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-