@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateStackRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
The input for CreateStack action.
NOOP
Constructor and Description |
---|
CreateStackRequest() |
Modifier and Type | Method and Description |
---|---|
CreateStackRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
List<String> |
getCapabilities()
A list of values that you must specify before AWS CloudFormation can create certain stacks.
|
String |
getClientRequestToken()
A unique identifier for this
CreateStack request. |
Boolean |
getDisableRollback()
Set to
true to disable rollback of the stack if stack creation failed. |
Boolean |
getEnableTerminationProtection()
Whether to enable termination protection on the specified stack.
|
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 of
Parameter 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 as
AWS::EC2::Instance , AWS::EC2::* , or Custom::MyCustomInstance . |
String |
getRoleARN()
The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation
assumes to create the stack.
|
RollbackConfiguration |
getRollbackConfiguration()
The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for
the specified monitoring period afterwards.
|
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; if
DisableRollback
is not set or is set to false , the stack will be rolled back. |
int |
hashCode() |
Boolean |
isDisableRollback()
Set to
true to disable rollback of the stack if stack creation failed. |
Boolean |
isEnableTerminationProtection()
Whether to enable termination protection on the specified stack.
|
void |
setCapabilities(Collection<String> capabilities)
A list of values that you must specify before AWS CloudFormation can create certain stacks.
|
void |
setClientRequestToken(String clientRequestToken)
A unique identifier for this
CreateStack request. |
void |
setDisableRollback(Boolean disableRollback)
Set to
true to disable rollback of the stack if stack creation failed. |
void |
setEnableTerminationProtection(Boolean enableTerminationProtection)
Whether to enable termination protection on the specified stack.
|
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 of
Parameter 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 as
AWS::EC2::Instance , AWS::EC2::* , or Custom::MyCustomInstance . |
void |
setRoleARN(String roleARN)
The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation
assumes to create the stack.
|
void |
setRollbackConfiguration(RollbackConfiguration rollbackConfiguration)
The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for
the specified monitoring period afterwards.
|
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; if
DisableRollback
is not set or is set to false , 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 values that you must specify before AWS CloudFormation can create certain stacks.
|
CreateStackRequest |
withCapabilities(Collection<String> capabilities)
A list of values that you must specify before AWS CloudFormation can create certain stacks.
|
CreateStackRequest |
withCapabilities(String... capabilities)
A list of values that you must specify before AWS CloudFormation can create certain stacks.
|
CreateStackRequest |
withClientRequestToken(String clientRequestToken)
A unique identifier for this
CreateStack request. |
CreateStackRequest |
withDisableRollback(Boolean disableRollback)
Set to
true to disable rollback of the stack if stack creation failed. |
CreateStackRequest |
withEnableTerminationProtection(Boolean enableTerminationProtection)
Whether to enable termination protection on the specified stack.
|
CreateStackRequest |
withNotificationARNs(Collection<String> notificationARNs)
The Simple Notification Service (SNS) topic ARNs to publish stack related events.
|
CreateStackRequest |
withNotificationARNs(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(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(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::* , or Custom::MyCustomInstance . |
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::* , or Custom::MyCustomInstance . |
CreateStackRequest |
withRoleARN(String roleARN)
The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation
assumes to create the stack.
|
CreateStackRequest |
withRollbackConfiguration(RollbackConfiguration rollbackConfiguration)
The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for
the specified monitoring period afterwards.
|
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(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(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; if
DisableRollback
is not set or is set to false , the stack will be rolled back. |
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
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.
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 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(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(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 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(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(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 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(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 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(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(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(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 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(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 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 setRollbackConfiguration(RollbackConfiguration rollbackConfiguration)
The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
rollbackConfiguration
- The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and
for the specified monitoring period afterwards.public RollbackConfiguration getRollbackConfiguration()
The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
public CreateStackRequest withRollbackConfiguration(RollbackConfiguration rollbackConfiguration)
The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
rollbackConfiguration
- The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and
for the specified monitoring period afterwards.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 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 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(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 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).
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).
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(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(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).
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 List<String> getCapabilities()
A list of values 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.
The only valid values are CAPABILITY_IAM
and CAPABILITY_NAMED_IAM
. The following
resources require you to specify this parameter:
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 you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you
must specify CAPABILITY_NAMED_IAM
. If you don't specify this parameter, this action returns an
InsufficientCapabilities
error.
For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
The only valid values are CAPABILITY_IAM
and CAPABILITY_NAMED_IAM
. The
following resources require you to specify this parameter:
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 you have IAM resources, you can specify either capability. If you have IAM resources with custom
names, you must specify CAPABILITY_NAMED_IAM
. If you don't specify this parameter, this
action returns an InsufficientCapabilities
error.
For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
Capability
public void setCapabilities(Collection<String> capabilities)
A list of values 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.
The only valid values are CAPABILITY_IAM
and CAPABILITY_NAMED_IAM
. The following
resources require you to specify this parameter:
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 you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you
must specify CAPABILITY_NAMED_IAM
. If you don't specify this parameter, this action returns an
InsufficientCapabilities
error.
For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
capabilities
- A list of values 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.
The only valid values are CAPABILITY_IAM
and CAPABILITY_NAMED_IAM
. The following
resources require you to specify this parameter:
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 you have IAM resources, you can specify either capability. If you have IAM resources with custom names,
you must specify CAPABILITY_NAMED_IAM
. If you don't specify this parameter, this action
returns an InsufficientCapabilities
error.
For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
Capability
public CreateStackRequest withCapabilities(String... capabilities)
A list of values 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.
The only valid values are CAPABILITY_IAM
and CAPABILITY_NAMED_IAM
. The following
resources require you to specify this parameter:
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 you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you
must specify CAPABILITY_NAMED_IAM
. If you don't specify this parameter, this action returns an
InsufficientCapabilities
error.
For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
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 values 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.
The only valid values are CAPABILITY_IAM
and CAPABILITY_NAMED_IAM
. The following
resources require you to specify this parameter:
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 you have IAM resources, you can specify either capability. If you have IAM resources with custom names,
you must specify CAPABILITY_NAMED_IAM
. If you don't specify this parameter, this action
returns an InsufficientCapabilities
error.
For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
Capability
public CreateStackRequest withCapabilities(Collection<String> capabilities)
A list of values 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.
The only valid values are CAPABILITY_IAM
and CAPABILITY_NAMED_IAM
. The following
resources require you to specify this parameter:
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 you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you
must specify CAPABILITY_NAMED_IAM
. If you don't specify this parameter, this action returns an
InsufficientCapabilities
error.
For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
capabilities
- A list of values 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.
The only valid values are CAPABILITY_IAM
and CAPABILITY_NAMED_IAM
. The following
resources require you to specify this parameter:
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 you have IAM resources, you can specify either capability. If you have IAM resources with custom names,
you must specify CAPABILITY_NAMED_IAM
. If you don't specify this parameter, this action
returns an InsufficientCapabilities
error.
For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
Capability
public CreateStackRequest withCapabilities(Capability... capabilities)
A list of values 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.
The only valid values are CAPABILITY_IAM
and CAPABILITY_NAMED_IAM
. The following
resources require you to specify this parameter:
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 you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you
must specify CAPABILITY_NAMED_IAM
. If you don't specify this parameter, this action returns an
InsufficientCapabilities
error.
For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
capabilities
- A list of values 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.
The only valid values are CAPABILITY_IAM
and CAPABILITY_NAMED_IAM
. The following
resources require you to specify this parameter:
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 you have IAM resources, you can specify either capability. If you have IAM resources with custom names,
you must specify CAPABILITY_NAMED_IAM
. If you don't specify this parameter, this action
returns an InsufficientCapabilities
error.
For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
Capability
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::*
, 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(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::*
, 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(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(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::*
, 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 setRoleARN(String roleARN)
The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to create the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.
If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.
roleARN
- The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation
assumes to create the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf.
AWS CloudFormation always uses this role for all future operations on the stack. As long as users have
permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have
permission to pass it. Ensure that the role grants least privilege.
If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.
public String getRoleARN()
The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to create the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.
If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.
If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.
public CreateStackRequest withRoleARN(String roleARN)
The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to create the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.
If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.
roleARN
- The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation
assumes to create the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf.
AWS CloudFormation always uses this role for all future operations on the stack. As long as users have
permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have
permission to pass it. Ensure that the role grants least privilege.
If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.
public void 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
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 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(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(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 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(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(String stackPolicyURL)
Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in
an S3 bucket in the same region as the stack. You can specify either the StackPolicyBody
or the
StackPolicyURL
parameter, but not both.
stackPolicyURL
- Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB)
located in an S3 bucket in the same region as the stack. You can specify either the
StackPolicyBody
or the StackPolicyURL
parameter, but not both.public String getStackPolicyURL()
Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in
an S3 bucket in the same region as the stack. You can specify either the StackPolicyBody
or the
StackPolicyURL
parameter, but not both.
StackPolicyBody
or the StackPolicyURL
parameter, but not both.public CreateStackRequest withStackPolicyURL(String stackPolicyURL)
Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in
an S3 bucket in the same region as the stack. You can specify either the StackPolicyBody
or the
StackPolicyURL
parameter, but not both.
stackPolicyURL
- Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB)
located in an S3 bucket in the same region as the stack. You can specify either the
StackPolicyBody
or the StackPolicyURL
parameter, but not both.public 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 50 tags can be specified.
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 50 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 50 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 50 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 50 tags can be specified.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 50 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 50 tags can be specified.public void setClientRequestToken(String clientRequestToken)
A unique identifier for this CreateStack
request. Specify this token if you plan to retry requests
so that AWS CloudFormation knows that you're not attempting to create a stack with the same name. You might retry
CreateStack
requests to ensure that AWS CloudFormation successfully received them.
All events triggered by a given stack operation are assigned the same client request token, which you can use to
track operations. For example, if you execute a CreateStack
operation with the token
token1
, then all the StackEvents
generated by that operation will have
ClientRequestToken
set as token1
.
In the console, stack operations display the client request token on the Events tab. Stack operations that are
initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify
the stack operation . For example, if you create a stack using the console, each stack event would be assigned
the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002
.
clientRequestToken
- A unique identifier for this CreateStack
request. Specify this token if you plan to retry
requests so that AWS CloudFormation knows that you're not attempting to create a stack with the same name.
You might retry CreateStack
requests to ensure that AWS CloudFormation successfully received
them.
All events triggered by a given stack operation are assigned the same client request token, which you can
use to track operations. For example, if you execute a CreateStack
operation with the token
token1
, then all the StackEvents
generated by that operation will have
ClientRequestToken
set as token1
.
In the console, stack operations display the client request token on the Events tab. Stack operations that
are initiated from the console use the token format Console-StackOperation-ID, which helps you
easily identify the stack operation . For example, if you create a stack using the console, each stack
event would be assigned the same token in the following format:
Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002
.
public String getClientRequestToken()
A unique identifier for this CreateStack
request. Specify this token if you plan to retry requests
so that AWS CloudFormation knows that you're not attempting to create a stack with the same name. You might retry
CreateStack
requests to ensure that AWS CloudFormation successfully received them.
All events triggered by a given stack operation are assigned the same client request token, which you can use to
track operations. For example, if you execute a CreateStack
operation with the token
token1
, then all the StackEvents
generated by that operation will have
ClientRequestToken
set as token1
.
In the console, stack operations display the client request token on the Events tab. Stack operations that are
initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify
the stack operation . For example, if you create a stack using the console, each stack event would be assigned
the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002
.
CreateStack
request. Specify this token if you plan to retry
requests so that AWS CloudFormation knows that you're not attempting to create a stack with the same
name. You might retry CreateStack
requests to ensure that AWS CloudFormation successfully
received them.
All events triggered by a given stack operation are assigned the same client request token, which you can
use to track operations. For example, if you execute a CreateStack
operation with the token
token1
, then all the StackEvents
generated by that operation will have
ClientRequestToken
set as token1
.
In the console, stack operations display the client request token on the Events tab. Stack operations
that are initiated from the console use the token format Console-StackOperation-ID, which helps
you easily identify the stack operation . For example, if you create a stack using the console, each
stack event would be assigned the same token in the following format:
Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002
.
public CreateStackRequest withClientRequestToken(String clientRequestToken)
A unique identifier for this CreateStack
request. Specify this token if you plan to retry requests
so that AWS CloudFormation knows that you're not attempting to create a stack with the same name. You might retry
CreateStack
requests to ensure that AWS CloudFormation successfully received them.
All events triggered by a given stack operation are assigned the same client request token, which you can use to
track operations. For example, if you execute a CreateStack
operation with the token
token1
, then all the StackEvents
generated by that operation will have
ClientRequestToken
set as token1
.
In the console, stack operations display the client request token on the Events tab. Stack operations that are
initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify
the stack operation . For example, if you create a stack using the console, each stack event would be assigned
the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002
.
clientRequestToken
- A unique identifier for this CreateStack
request. Specify this token if you plan to retry
requests so that AWS CloudFormation knows that you're not attempting to create a stack with the same name.
You might retry CreateStack
requests to ensure that AWS CloudFormation successfully received
them.
All events triggered by a given stack operation are assigned the same client request token, which you can
use to track operations. For example, if you execute a CreateStack
operation with the token
token1
, then all the StackEvents
generated by that operation will have
ClientRequestToken
set as token1
.
In the console, stack operations display the client request token on the Events tab. Stack operations that
are initiated from the console use the token format Console-StackOperation-ID, which helps you
easily identify the stack operation . For example, if you create a stack using the console, each stack
event would be assigned the same token in the following format:
Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002
.
public void setEnableTerminationProtection(Boolean enableTerminationProtection)
Whether to enable termination protection on the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide. Termination protection is disabled on stacks by default.
For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack.
enableTerminationProtection
- Whether to enable termination protection on the specified stack. If a user attempts to delete a stack with
termination protection enabled, the operation fails and the stack remains unchanged. For more information,
see
Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide. Termination
protection is disabled on stacks by default.
For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack.
public Boolean getEnableTerminationProtection()
Whether to enable termination protection on the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide. Termination protection is disabled on stacks by default.
For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack.
For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack.
public CreateStackRequest withEnableTerminationProtection(Boolean enableTerminationProtection)
Whether to enable termination protection on the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide. Termination protection is disabled on stacks by default.
For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack.
enableTerminationProtection
- Whether to enable termination protection on the specified stack. If a user attempts to delete a stack with
termination protection enabled, the operation fails and the stack remains unchanged. For more information,
see
Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide. Termination
protection is disabled on stacks by default.
For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack.
public Boolean isEnableTerminationProtection()
Whether to enable termination protection on the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide. Termination protection is disabled on stacks by default.
For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack.
For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack.
public String toString()
toString
in class Object
Object.toString()
public CreateStackRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.