@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()
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order
for CloudFormation to create the stack.
|
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 Amazon Simple Notification Service (Amazon 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. |
Boolean |
getRetainExceptOnCreate()
When set to
true, newly created resources are deleted when the operation rolls back. |
String |
getRoleARN()
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to
create the stack.
|
RollbackConfiguration |
getRollbackConfiguration()
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the
specified monitoring period afterwards.
|
String |
getStackName()
The name that's 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.
|
Boolean |
isRetainExceptOnCreate()
When set to
true, newly created resources are deleted when the operation rolls back. |
void |
setCapabilities(Collection<String> capabilities)
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order
for CloudFormation to create the stack.
|
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 Amazon Simple Notification Service (Amazon 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 |
setRetainExceptOnCreate(Boolean retainExceptOnCreate)
When set to
true, newly created resources are deleted when the operation rolls back. |
void |
setRoleARN(String roleARN)
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to
create the stack.
|
void |
setRollbackConfiguration(RollbackConfiguration rollbackConfiguration)
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the
specified monitoring period afterwards.
|
void |
setStackName(String stackName)
The name that's 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.
|
CreateStackRequest |
withCapabilities(Capability... capabilities)
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order
for CloudFormation to create the stack.
|
CreateStackRequest |
withCapabilities(Collection<String> capabilities)
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order
for CloudFormation to create the stack.
|
CreateStackRequest |
withCapabilities(String... capabilities)
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order
for CloudFormation to create the stack.
|
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 Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish stack related events.
|
CreateStackRequest |
withNotificationARNs(String... notificationARNs)
The Amazon Simple Notification Service (Amazon 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 |
withRetainExceptOnCreate(Boolean retainExceptOnCreate)
When set to
true, newly created resources are deleted when the operation rolls back. |
CreateStackRequest |
withRoleARN(String roleARN)
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to
create the stack.
|
CreateStackRequest |
withRollbackConfiguration(RollbackConfiguration rollbackConfiguration)
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the
specified monitoring period afterwards.
|
CreateStackRequest |
withStackName(String stackName)
The name that's 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, withSdkRequestTimeoutpublic void setStackName(String stackName)
The name that's 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 alphabetical character and can't be longer than 128 characters.
stackName - The name that's 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 alphabetical character and can't be longer than 128 characters.
public String getStackName()
The name that's 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 alphabetical character and can't be longer than 128 characters.
A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an alphabetical character and can't be longer than 128 characters.
public CreateStackRequest withStackName(String stackName)
The name that's 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 alphabetical character and can't be longer than 128 characters.
stackName - The name that's 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 alphabetical character and can't 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 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 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 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 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 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's
located in an Amazon S3 bucket or a Systems Manager document. For more information, go to the Template anatomy
in the CloudFormation User Guide. The location for an Amazon S3 bucket must start with
https://.
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's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to the Template
anatomy in the CloudFormation User Guide. The location for an Amazon S3 bucket must start with
https://.
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's
located in an Amazon S3 bucket or a Systems Manager document. For more information, go to the Template anatomy
in the CloudFormation User Guide. The location for an Amazon S3 bucket must start with
https://.
Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but
not both.
https://.
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's
located in an Amazon S3 bucket or a Systems Manager document. For more information, go to the Template anatomy
in the CloudFormation User Guide. The location for an Amazon S3 bucket must start with
https://.
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's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to the Template
anatomy in the CloudFormation User Guide. The location for an Amazon S3 bucket must start with
https://.
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 CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
rollbackConfiguration - The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for
the specified monitoring period afterwards.public RollbackConfiguration getRollbackConfiguration()
The rollback triggers for 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 CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
rollbackConfiguration - The rollback triggers for 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.
CREATE_FAILED; if
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 Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish stack related events. You can find your Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI).
public void setNotificationARNs(Collection<String> notificationARNs)
The Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish stack related events. You can find your Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI).
notificationARNs - The Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish stack related events. You can
find your Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI).public CreateStackRequest withNotificationARNs(String... notificationARNs)
The Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish stack related events. You can find your Amazon SNS topic ARNs using the Amazon 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 Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish stack related events. You can
find your Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI).public CreateStackRequest withNotificationARNs(Collection<String> notificationARNs)
The Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish stack related events. You can find your Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI).
notificationARNs - The Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish stack related events. You can
find your Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI).public List<String> getCapabilities()
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or
CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an
InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
If you want to create a stack from a stack template that contains macros and nested stacks, you must create the stack directly from the template using this capability.
You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.
For more information, see Using CloudFormation macros to perform custom processing on templates.
Only one of the Capabilities and ResourceType parameters can be specified.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or
CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an
InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
If you want to create a stack from a stack template that contains macros and nested stacks, you must create the stack directly from the template using this capability.
You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.
For more information, see Using CloudFormation macros to perform custom processing on templates.
Only one of the Capabilities and ResourceType parameters can be specified.
Capabilitypublic void setCapabilities(Collection<String> capabilities)
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or
CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an
InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
If you want to create a stack from a stack template that contains macros and nested stacks, you must create the stack directly from the template using this capability.
You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.
For more information, see Using CloudFormation macros to perform custom processing on templates.
Only one of the Capabilities and ResourceType parameters can be specified.
capabilities - In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in
order for CloudFormation to create the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or
CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an
InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
If you want to create a stack from a stack template that contains macros and nested stacks, you must create the stack directly from the template using this capability.
You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.
For more information, see Using CloudFormation macros to perform custom processing on templates.
Only one of the Capabilities and ResourceType parameters can be specified.
Capabilitypublic CreateStackRequest withCapabilities(String... capabilities)
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or
CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an
InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
If you want to create a stack from a stack template that contains macros and nested stacks, you must create the stack directly from the template using this capability.
You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.
For more information, see Using CloudFormation macros to perform custom processing on templates.
Only one of the Capabilities and ResourceType parameters can be specified.
NOTE: This method appends the values to the existing list (if any). Use
setCapabilities(java.util.Collection) or withCapabilities(java.util.Collection) if you want to
override the existing values.
capabilities - In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in
order for CloudFormation to create the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or
CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an
InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
If you want to create a stack from a stack template that contains macros and nested stacks, you must create the stack directly from the template using this capability.
You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.
For more information, see Using CloudFormation macros to perform custom processing on templates.
Only one of the Capabilities and ResourceType parameters can be specified.
Capabilitypublic CreateStackRequest withCapabilities(Collection<String> capabilities)
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or
CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an
InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
If you want to create a stack from a stack template that contains macros and nested stacks, you must create the stack directly from the template using this capability.
You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.
For more information, see Using CloudFormation macros to perform custom processing on templates.
Only one of the Capabilities and ResourceType parameters can be specified.
capabilities - In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in
order for CloudFormation to create the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or
CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an
InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
If you want to create a stack from a stack template that contains macros and nested stacks, you must create the stack directly from the template using this capability.
You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.
For more information, see Using CloudFormation macros to perform custom processing on templates.
Only one of the Capabilities and ResourceType parameters can be specified.
Capabilitypublic CreateStackRequest withCapabilities(Capability... capabilities)
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or
CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an
InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
If you want to create a stack from a stack template that contains macros and nested stacks, you must create the stack directly from the template using this capability.
You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.
For more information, see Using CloudFormation macros to perform custom processing on templates.
Only one of the Capabilities and ResourceType parameters can be specified.
capabilities - In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in
order for CloudFormation to create the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or
CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an
InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
If you want to create a stack from a stack template that contains macros and nested stacks, you must create the stack directly from the template using this capability.
You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.
For more information, see Using CloudFormation macros to perform custom processing on templates.
Only one of the Capabilities and ResourceType parameters can be specified.
Capabilitypublic 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 Amazon Web Services
resources), Custom::* (for all custom resources), Custom::logical_ID (for a
specific custom resource), AWS::service_name::* (for all resources of a particular Amazon Web
Services service), and AWS::service_name::resource_logical_ID (for a specific Amazon
Web Services resource).
If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.
Only one of the Capabilities and ResourceType parameters can be specified.
AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. Use
the following syntax to describe template resource types: AWS::* (for all Amazon Web
Services resources), Custom::* (for all custom resources),
Custom::logical_ID (for a specific custom resource),
AWS::service_name::* (for all resources of a particular Amazon Web Services service),
and AWS::service_name::resource_logical_ID (for a specific Amazon Web
Services resource).
If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.
Only one of the Capabilities and ResourceType parameters can be specified.
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 Amazon Web Services
resources), Custom::* (for all custom resources), Custom::logical_ID (for a
specific custom resource), AWS::service_name::* (for all resources of a particular Amazon Web
Services service), and AWS::service_name::resource_logical_ID (for a specific Amazon
Web Services resource).
If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.
Only one of the Capabilities and ResourceType parameters can be specified.
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 Amazon Web Services
resources), Custom::* (for all custom resources), Custom::logical_ID
(for a specific custom resource), AWS::service_name::* (for all resources of a
particular Amazon Web Services service), and
AWS::service_name::resource_logical_ID (for a specific Amazon Web Services
resource).
If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.
Only one of the Capabilities and ResourceType parameters can be specified.
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 Amazon Web Services
resources), Custom::* (for all custom resources), Custom::logical_ID (for a
specific custom resource), AWS::service_name::* (for all resources of a particular Amazon Web
Services service), and AWS::service_name::resource_logical_ID (for a specific Amazon
Web Services resource).
If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.
Only one of the Capabilities and ResourceType parameters can be specified.
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 Amazon Web Services
resources), Custom::* (for all custom resources), Custom::logical_ID
(for a specific custom resource), AWS::service_name::* (for all resources of a
particular Amazon Web Services service), and
AWS::service_name::resource_logical_ID (for a specific Amazon Web Services
resource).
If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.
Only one of the Capabilities and ResourceType parameters can be specified.
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 Amazon Web Services
resources), Custom::* (for all custom resources), Custom::logical_ID (for a
specific custom resource), AWS::service_name::* (for all resources of a particular Amazon Web
Services service), and AWS::service_name::resource_logical_ID (for a specific Amazon
Web Services resource).
If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.
Only one of the Capabilities and ResourceType parameters can be specified.
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 Amazon Web Services
resources), Custom::* (for all custom resources), Custom::logical_ID
(for a specific custom resource), AWS::service_name::* (for all resources of a
particular Amazon Web Services service), and
AWS::service_name::resource_logical_ID (for a specific Amazon Web Services
resource).
If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.
Only one of the Capabilities and ResourceType parameters can be specified.
public void setRoleARN(String roleARN)
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to create the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials.
roleARN - The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes
to create the stack. CloudFormation uses the role's credentials to make calls on your behalf.
CloudFormation always uses this role for all future operations on the stack. Provided that users have
permission to operate on the stack, CloudFormation uses this role even if the users don't have permission
to pass it. Ensure that the role grants least privilege.
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials.
public String getRoleARN()
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to create the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials.
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials.
public CreateStackRequest withRoleARN(String roleARN)
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to create the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials.
roleARN - The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes
to create the stack. CloudFormation uses the role's credentials to make calls on your behalf.
CloudFormation always uses this role for all future operations on the stack. Provided that users have
permission to operate on the stack, CloudFormation uses this role even if the users don't have permission
to pass it. Ensure that the role grants least privilege.
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's 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
OnFailurepublic 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
DO_NOTHING, ROLLBACK, or DELETE. You can specify either
OnFailure or DisableRollback, but not both.
Default: ROLLBACK
OnFailurepublic 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
OnFailurepublic 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
OnFailurepublic 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
OnFailurepublic void setStackPolicyBody(String stackPolicyBody)
Structure containing the stack policy body. For more information, go to Prevent
Updates to Stack Resources in the 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 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 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 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 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. The location for an Amazon S3 bucket must start with
https://. 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. The location for an Amazon S3 bucket must start
with https://. 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. The location for an Amazon S3 bucket must start with
https://. You can specify either the StackPolicyBody or the StackPolicyURL
parameter, but not both.
https://. You can specify either the 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. The location for an Amazon S3 bucket must start with
https://. 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. The location for an Amazon S3 bucket must start
with https://. 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. 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. 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. 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. 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. 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. 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. 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 CloudFormation knows that you're not attempting to create a stack with the same name. You might retry
CreateStack requests to ensure that CloudFormation successfully received them.
All events initiated 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 CloudFormation knows that you're not attempting to create a stack with the same name. You
might retry CreateStack requests to ensure that CloudFormation successfully received
them.
All events initiated 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 CloudFormation knows that you're not attempting to create a stack with the same name. You might retry
CreateStack requests to ensure that CloudFormation successfully received them.
All events initiated 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 CloudFormation knows that you're not attempting to create a stack with the same name.
You might retry CreateStack requests to ensure that CloudFormation successfully received
them.
All events initiated 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 CloudFormation knows that you're not attempting to create a stack with the same name. You might retry
CreateStack requests to ensure that CloudFormation successfully received them.
All events initiated 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 CloudFormation knows that you're not attempting to create a stack with the same name. You
might retry CreateStack requests to ensure that CloudFormation successfully received
them.
All events initiated 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 CloudFormation User Guide. Termination protection is deactivated on stacks by default.
For nested stacks, termination protection is set on the root stack and can't 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 CloudFormation User Guide. Termination protection
is deactivated on stacks by default.
For nested stacks, termination protection is set on the root stack and can't 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 CloudFormation User Guide. Termination protection is deactivated on stacks by default.
For nested stacks, termination protection is set on the root stack and can't be changed directly on the nested stack.
For nested stacks, termination protection is set on the root stack and can't 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 CloudFormation User Guide. Termination protection is deactivated on stacks by default.
For nested stacks, termination protection is set on the root stack and can't 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 CloudFormation User Guide. Termination protection
is deactivated on stacks by default.
For nested stacks, termination protection is set on the root stack and can't 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 CloudFormation User Guide. Termination protection is deactivated on stacks by default.
For nested stacks, termination protection is set on the root stack and can't be changed directly on the nested stack.
For nested stacks, termination protection is set on the root stack and can't be changed directly on the nested stack.
public void setRetainExceptOnCreate(Boolean retainExceptOnCreate)
When set to true, newly created resources are deleted when the operation rolls back. This includes
newly created resources marked with a deletion policy of Retain.
Default: false
retainExceptOnCreate - When set to true, newly created resources are deleted when the operation rolls back. This
includes newly created resources marked with a deletion policy of Retain.
Default: false
public Boolean getRetainExceptOnCreate()
When set to true, newly created resources are deleted when the operation rolls back. This includes
newly created resources marked with a deletion policy of Retain.
Default: false
true, newly created resources are deleted when the operation rolls back. This
includes newly created resources marked with a deletion policy of Retain.
Default: false
public CreateStackRequest withRetainExceptOnCreate(Boolean retainExceptOnCreate)
When set to true, newly created resources are deleted when the operation rolls back. This includes
newly created resources marked with a deletion policy of Retain.
Default: false
retainExceptOnCreate - When set to true, newly created resources are deleted when the operation rolls back. This
includes newly created resources marked with a deletion policy of Retain.
Default: false
public Boolean isRetainExceptOnCreate()
When set to true, newly created resources are deleted when the operation rolls back. This includes
newly created resources marked with a deletion policy of Retain.
Default: false
true, newly created resources are deleted when the operation rolls back. This
includes newly created resources marked with a deletion policy of Retain.
Default: false
public String toString()
toString in class ObjectObject.toString()public CreateStackRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()