public class CreateStackRequest extends AmazonWebServiceRequest implements java.io.Serializable, java.lang.Cloneable
The input for CreateStack action.
Modifier and Type | Field and Description |
---|---|
private SdkInternalList<java.lang.String> |
capabilities
A list of capabilities that you must specify before AWS CloudFormation
can create certain stacks.
|
private java.lang.Boolean |
disableRollback
Set to
true to disable rollback of the stack if stack
creation failed. |
private SdkInternalList<java.lang.String> |
notificationARNs
The Simple Notification Service (SNS) topic ARNs to publish stack related
events.
|
private java.lang.String |
onFailure
Determines what action will be taken if stack creation fails.
|
private SdkInternalList<Parameter> |
parameters
A list of
Parameter structures that specify input parameters
for the stack. |
private SdkInternalList<java.lang.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::* , or Custom::MyCustomInstance . |
private java.lang.String |
stackName
The name that is associated with the stack.
|
private java.lang.String |
stackPolicyBody
Structure containing the stack policy body.
|
private java.lang.String |
stackPolicyURL
Location of a file containing the stack policy.
|
private SdkInternalList<Tag> |
tags
Key-value pairs to associate with this stack.
|
private java.lang.String |
templateBody
Structure containing the template body with a minimum length of 1 byte
and a maximum length of 51,200 bytes.
|
private java.lang.String |
templateURL
Location of file containing the template body.
|
private java.lang.Integer |
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. |
NOOP
Constructor and Description |
---|
CreateStackRequest() |
Modifier and Type | Method and Description |
---|---|
CreateStackRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(java.lang.Object obj) |
java.util.List<java.lang.String> |
getCapabilities()
A list of capabilities that you must specify before AWS CloudFormation
can create certain stacks.
|
java.lang.Boolean |
getDisableRollback()
Set to
true to disable rollback of the stack if stack
creation failed. |
java.util.List<java.lang.String> |
getNotificationARNs()
The Simple Notification Service (SNS) topic ARNs to publish stack related
events.
|
java.lang.String |
getOnFailure()
Determines what action will be taken if stack creation fails.
|
java.util.List<Parameter> |
getParameters()
A list of
Parameter structures that specify input parameters
for the stack. |
java.util.List<java.lang.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::* , or Custom::MyCustomInstance . |
java.lang.String |
getStackName()
The name that is associated with the stack.
|
java.lang.String |
getStackPolicyBody()
Structure containing the stack policy body.
|
java.lang.String |
getStackPolicyURL()
Location of a file containing the stack policy.
|
java.util.List<Tag> |
getTags()
Key-value pairs to associate with this stack.
|
java.lang.String |
getTemplateBody()
Structure containing the template body with a minimum length of 1 byte
and a maximum length of 51,200 bytes.
|
java.lang.String |
getTemplateURL()
Location of file containing the template body.
|
java.lang.Integer |
getTimeoutInMinutes()
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. |
int |
hashCode() |
java.lang.Boolean |
isDisableRollback()
Set to
true to disable rollback of the stack if stack
creation failed. |
void |
setCapabilities(java.util.Collection<java.lang.String> capabilities)
A list of capabilities that you must specify before AWS CloudFormation
can create certain stacks.
|
void |
setDisableRollback(java.lang.Boolean disableRollback)
Set to
true to disable rollback of the stack if stack
creation failed. |
void |
setNotificationARNs(java.util.Collection<java.lang.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(java.lang.String onFailure)
Determines what action will be taken if stack creation fails.
|
void |
setParameters(java.util.Collection<Parameter> parameters)
A list of
Parameter structures that specify input parameters
for the stack. |
void |
setResourceTypes(java.util.Collection<java.lang.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::* , or Custom::MyCustomInstance . |
void |
setStackName(java.lang.String stackName)
The name that is associated with the stack.
|
void |
setStackPolicyBody(java.lang.String stackPolicyBody)
Structure containing the stack policy body.
|
void |
setStackPolicyURL(java.lang.String stackPolicyURL)
Location of a file containing the stack policy.
|
void |
setTags(java.util.Collection<Tag> tags)
Key-value pairs to associate with this stack.
|
void |
setTemplateBody(java.lang.String templateBody)
Structure containing the template body with a minimum length of 1 byte
and a maximum length of 51,200 bytes.
|
void |
setTemplateURL(java.lang.String templateURL)
Location of file containing the template body.
|
void |
setTimeoutInMinutes(java.lang.Integer 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. |
java.lang.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(java.util.Collection<java.lang.String> capabilities)
A list of capabilities that you must specify before AWS CloudFormation
can create certain stacks.
|
CreateStackRequest |
withCapabilities(java.lang.String... capabilities)
A list of capabilities that you must specify before AWS CloudFormation
can create certain stacks.
|
CreateStackRequest |
withDisableRollback(java.lang.Boolean disableRollback)
Set to
true to disable rollback of the stack if stack
creation failed. |
CreateStackRequest |
withNotificationARNs(java.util.Collection<java.lang.String> notificationARNs)
The Simple Notification Service (SNS) topic ARNs to publish stack related
events.
|
CreateStackRequest |
withNotificationARNs(java.lang.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(java.lang.String onFailure)
Determines what action will be taken if stack creation fails.
|
CreateStackRequest |
withParameters(java.util.Collection<Parameter> parameters)
A list of
Parameter structures that specify input parameters
for the stack. |
CreateStackRequest |
withParameters(Parameter... parameters)
A list of
Parameter structures that specify input parameters
for the stack. |
CreateStackRequest |
withResourceTypes(java.util.Collection<java.lang.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::* , or Custom::MyCustomInstance . |
CreateStackRequest |
withResourceTypes(java.lang.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::* , or Custom::MyCustomInstance . |
CreateStackRequest |
withStackName(java.lang.String stackName)
The name that is associated with the stack.
|
CreateStackRequest |
withStackPolicyBody(java.lang.String stackPolicyBody)
Structure containing the stack policy body.
|
CreateStackRequest |
withStackPolicyURL(java.lang.String stackPolicyURL)
Location of a file containing the stack policy.
|
CreateStackRequest |
withTags(java.util.Collection<Tag> tags)
Key-value pairs to associate with this stack.
|
CreateStackRequest |
withTags(Tag... tags)
Key-value pairs to associate with this stack.
|
CreateStackRequest |
withTemplateBody(java.lang.String templateBody)
Structure containing the template body with a minimum length of 1 byte
and a maximum length of 51,200 bytes.
|
CreateStackRequest |
withTemplateURL(java.lang.String templateURL)
Location of file containing the template body.
|
CreateStackRequest |
withTimeoutInMinutes(java.lang.Integer 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. |
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
private java.lang.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.
private java.lang.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 the
TemplateURL
parameter, but not both.
private java.lang.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 the
TemplateURL
parameter, but not both.
private SdkInternalList<Parameter> parameters
A list of Parameter
structures that specify input parameters
for the stack. For more information, see the Parameter data type.
private java.lang.Boolean 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
private java.lang.Integer 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.
private SdkInternalList<java.lang.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).
private SdkInternalList<java.lang.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 an InsufficientCapabilities
error.
private SdkInternalList<java.lang.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::*
, 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 java.lang.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
or DisableRollback
, but not both.
Default: ROLLBACK
private java.lang.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 the
StackPolicyURL
parameter, but not both.
private java.lang.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 the
StackPolicyURL
parameter, but not both.
private SdkInternalList<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.
public void setStackName(java.lang.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.
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 java.lang.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.
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 CreateStackRequest withStackName(java.lang.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.
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 setTemplateBody(java.lang.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 the
TemplateURL
parameter, but not both.
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 java.lang.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 the
TemplateURL
parameter, but not both.
Conditional: You must specify either the
TemplateBody
or the TemplateURL
parameter, but not both.
public CreateStackRequest withTemplateBody(java.lang.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 the
TemplateURL
parameter, but not both.
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 setTemplateURL(java.lang.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 the
TemplateURL
parameter, but not both.
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 java.lang.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 the
TemplateURL
parameter, but not both.
Conditional: You must specify either the
TemplateBody
or the TemplateURL
parameter, but not both.
public CreateStackRequest withTemplateURL(java.lang.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 the
TemplateURL
parameter, but not both.
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 java.util.List<Parameter> getParameters()
A list of Parameter
structures that specify input parameters
for the stack. For more information, see the Parameter data type.
Parameter
structures that specify input
parameters for the stack. For more information, see the Parameter data type.public void setParameters(java.util.Collection<Parameter> parameters)
A list of Parameter
structures that specify input parameters
for the stack. For more information, see the Parameter data type.
parameters
- A list of Parameter
structures that specify input
parameters for the stack. For more information, see the Parameter data type.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)
or
withParameters(java.util.Collection)
if you want to override the
existing values.
parameters
- A list of Parameter
structures that specify input
parameters for the stack. For more information, see the Parameter data type.public CreateStackRequest withParameters(java.util.Collection<Parameter> parameters)
A list of Parameter
structures that specify input parameters
for the stack. For more information, see the Parameter data type.
parameters
- A list of Parameter
structures that specify input
parameters for the stack. For more information, see the Parameter data type.public void setDisableRollback(java.lang.Boolean 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
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 java.lang.Boolean getDisableRollback()
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
true
to disable rollback of the stack if
stack creation failed. You can specify either
DisableRollback
or OnFailure
, but not
both.
Default: false
public CreateStackRequest withDisableRollback(java.lang.Boolean 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
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 java.lang.Boolean isDisableRollback()
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
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 setTimeoutInMinutes(java.lang.Integer 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.
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 java.lang.Integer getTimeoutInMinutes()
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.
DisableRollback
is not set or is
set to false
, the stack will be rolled back.public CreateStackRequest withTimeoutInMinutes(java.lang.Integer 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.
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 java.util.List<java.lang.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).
public void setNotificationARNs(java.util.Collection<java.lang.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).
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 CreateStackRequest withNotificationARNs(java.lang.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)
or
withNotificationARNs(java.util.Collection)
if you want to
override the existing values.
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 CreateStackRequest withNotificationARNs(java.util.Collection<java.lang.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).
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 java.util.List<java.lang.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 an InsufficientCapabilities
error.
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 an
InsufficientCapabilities
error.
Capability
public void setCapabilities(java.util.Collection<java.lang.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 an InsufficientCapabilities
error.
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 an
InsufficientCapabilities
error.
Capability
public CreateStackRequest withCapabilities(java.lang.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 an InsufficientCapabilities
error.
NOTE: This method appends the values to the existing list (if
any). Use setCapabilities(java.util.Collection)
or
withCapabilities(java.util.Collection)
if you want to override
the existing values.
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 an
InsufficientCapabilities
error.
Capability
public CreateStackRequest withCapabilities(java.util.Collection<java.lang.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 an InsufficientCapabilities
error.
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 an
InsufficientCapabilities
error.
Capability
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 an InsufficientCapabilities
error.
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 an
InsufficientCapabilities
error.
Capability
public java.util.List<java.lang.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::*
, 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.
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<java.lang.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::*
, 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.
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 CreateStackRequest withResourceTypes(java.lang.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::*
, 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 setResourceTypes(java.util.Collection)
or
withResourceTypes(java.util.Collection)
if you want to override
the existing values.
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 CreateStackRequest withResourceTypes(java.util.Collection<java.lang.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::*
, 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.
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 setOnFailure(java.lang.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
or DisableRollback
, but not both.
Default: ROLLBACK
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
OnFailure
public java.lang.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
or DisableRollback
, but not both.
Default: ROLLBACK
OnFailure
or
DisableRollback
, but not both.
Default: ROLLBACK
OnFailure
public CreateStackRequest withOnFailure(java.lang.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
or DisableRollback
, but not both.
Default: ROLLBACK
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
OnFailure
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
or DisableRollback
, but not both.
Default: ROLLBACK
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
OnFailure
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
or DisableRollback
, but not both.
Default: ROLLBACK
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
OnFailure
public void setStackPolicyBody(java.lang.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 the
StackPolicyURL
parameter, but not both.
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 java.lang.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 the
StackPolicyURL
parameter, but not both.
StackPolicyBody
or the StackPolicyURL
parameter, but not both.public CreateStackRequest withStackPolicyBody(java.lang.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 the
StackPolicyURL
parameter, but not both.
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 setStackPolicyURL(java.lang.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 the
StackPolicyURL
parameter, but not both.
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 the StackPolicyURL
parameter, but not both.public java.lang.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 the
StackPolicyURL
parameter, but not both.
StackPolicyBody
or the StackPolicyURL
parameter, but not both.public CreateStackRequest withStackPolicyURL(java.lang.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 the
StackPolicyURL
parameter, but not both.
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 the StackPolicyURL
parameter, but not both.public java.util.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.
public void setTags(java.util.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.
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.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)
or
withTags(java.util.Collection)
if you want to override the
existing values.
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.public CreateStackRequest withTags(java.util.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.
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.public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public CreateStackRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()