com.amazonaws.services.cloudformation.model
Class CreateStackRequest

java.lang.Object
  com.amazonaws.AmazonWebServiceRequest
      com.amazonaws.services.cloudformation.model.CreateStackRequest

All Implemented Interfaces:

Serializable

public class CreateStackRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the CreateStack operation.

Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack via the DescribeStacks API.

NOTE: Currently, the limit for stacks is 20 stacks per account per region.

See Also:

AmazonCloudFormation.createStack(CreateStackRequest), Serialized Form

Constructor Summary

CreateStackRequest()

Method Summary

boolean	equals(Object obj)
List<String>	getCapabilities() The list of capabilities that you want to allow in the stack.
Boolean	getDisableRollback() Set to true to disable rollback of the stack if stack creation failed.
List<String>	getNotificationARNs() The Simple Notification Service (SNS) topic ARNs to publish stack related events.
String	getOnFailure() Determines what action will be taken if stack creation fails.
List<Parameter>	getParameters() A list of Parameter structures that specify input parameters for the stack.
String	getStackName() The name associated with the stack.
List<Tag>	getTags() A set of user-defined Tags to associate with this stack, represented by key/value pairs.
String	getTemplateBody() Structure containing the template body.
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.
void	setCapabilities(Collection<String> capabilities) The list of capabilities that you want to allow in the stack.
void	setDisableRollback(Boolean disableRollback) Set to true to disable rollback of the stack if stack creation failed.
void	setNotificationARNs(Collection<String> notificationARNs) The Simple Notification Service (SNS) topic ARNs to publish stack related events.
void	setOnFailure(OnFailure onFailure) Determines what action will be taken if stack creation fails.
void	setOnFailure(String onFailure) Determines what action will be taken if stack creation fails.
void	setParameters(Collection<Parameter> parameters) A list of Parameter structures that specify input parameters for the stack.
void	setStackName(String stackName) The name associated with the stack.
void	setTags(Collection<Tag> tags) A set of user-defined Tags to associate with this stack, represented by key/value pairs.
void	setTemplateBody(String templateBody) Structure containing the template body.
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(Collection<String> capabilities) The list of capabilities that you want to allow in the stack.
CreateStackRequest	withCapabilities(String... capabilities) The list of capabilities that you want to allow in the stack.
CreateStackRequest	withDisableRollback(Boolean disableRollback) Set to true to disable rollback of the stack if stack creation failed.
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	withStackName(String stackName) The name associated with the stack.
CreateStackRequest	withTags(Collection<Tag> tags) A set of user-defined Tags to associate with this stack, represented by key/value pairs.
CreateStackRequest	withTags(Tag... tags) A set of user-defined Tags to associate with this stack, represented by key/value pairs.
CreateStackRequest	withTemplateBody(String templateBody) Structure containing the template body.
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.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateStackRequest

public CreateStackRequest()

Method Detail

getStackName

public String getStackName()

The name associated with the stack. The name must be unique within your AWS account. Must contain only alphanumeric characters (case sensitive) and start with an alpha character. Maximum length of the name is 255 characters.

Returns:

The name associated with the stack. The name must be unique within your AWS account. Must contain only alphanumeric characters (case sensitive) and start with an alpha character. Maximum length of the name is 255 characters.

setStackName

public void setStackName(String stackName)

The name associated with the stack. The name must be unique within your AWS account. Must contain only alphanumeric characters (case sensitive) and start with an alpha character. Maximum length of the name is 255 characters.

Parameters:

stackName - The name associated with the stack. The name must be unique within your AWS account. Must contain only alphanumeric characters (case sensitive) and start with an alpha character. Maximum length of the name is 255 characters.

withStackName

public CreateStackRequest withStackName(String stackName)

The name associated with the stack. The name must be unique within your AWS account. Must contain only alphanumeric characters (case sensitive) and start with an alpha character. Maximum length of the name is 255 characters.

Returns a reference to this object so that method calls can be chained together.

Parameters:

stackName - The name associated with the stack. The name must be unique within your AWS account. Must contain only alphanumeric characters (case sensitive) and start with an alpha character. Maximum length of the name is 255 characters.

Returns:

A reference to this updated object so that method calls can be chained together.

getTemplateBody

public String getTemplateBody()

Structure containing the template body. (For more information, go to the AWS CloudFormation User Guide.)

Conditional: You must pass TemplateBody or TemplateURL. If both are passed, only TemplateBody is used.

Constraints:
Length: 1 - 51200

Returns:

Structure containing the template body. (For more information, go to the AWS CloudFormation User Guide.)

Conditional: You must pass TemplateBody or TemplateURL. If both are passed, only TemplateBody is used.

setTemplateBody

public void setTemplateBody(String templateBody)

Structure containing the template body. (For more information, go to the AWS CloudFormation User Guide.)

Conditional: You must pass TemplateBody or TemplateURL. If both are passed, only TemplateBody is used.

Constraints:
Length: 1 - 51200

Parameters:

templateBody - Structure containing the template body. (For more information, go to the AWS CloudFormation User Guide.)

Conditional: You must pass TemplateBody or TemplateURL. If both are passed, only TemplateBody is used.

withTemplateBody

public CreateStackRequest withTemplateBody(String templateBody)

Structure containing the template body. (For more information, go to the AWS CloudFormation User Guide.)

Conditional: You must pass TemplateBody or TemplateURL. If both are passed, only TemplateBody is used.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 51200

Parameters:

templateBody - Structure containing the template body. (For more information, go to the AWS CloudFormation User Guide.)

Conditional: You must pass TemplateBody or TemplateURL. If both are passed, only TemplateBody is used.

Returns:

A reference to this updated object so that method calls can be chained together.

getTemplateURL

public String getTemplateURL()

Location of file containing the template body. The URL must point to a template (max size: 307,200 bytes) located in an S3 bucket in the same region as the stack. For more information, go to the AWS CloudFormation User Guide.

Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.

Constraints:
Length: 1 - 1024

Returns:

Location of file containing the template body. The URL must point to a template (max size: 307,200 bytes) located in an S3 bucket in the same region as the stack. For more information, go to the AWS CloudFormation User Guide.

Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.

setTemplateURL

public void setTemplateURL(String templateURL)

Location of file containing the template body. The URL must point to a template (max size: 307,200 bytes) located in an S3 bucket in the same region as the stack. For more information, go to the AWS CloudFormation User Guide.

Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.

Constraints:
Length: 1 - 1024

Parameters:

templateURL - Location of file containing the template body. The URL must point to a template (max size: 307,200 bytes) located in an S3 bucket in the same region as the stack. For more information, go to the AWS CloudFormation User Guide.

Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.

withTemplateURL

public CreateStackRequest withTemplateURL(String templateURL)

Location of file containing the template body. The URL must point to a template (max size: 307,200 bytes) located in an S3 bucket in the same region as the stack. For more information, go to the AWS CloudFormation User Guide.

Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 1024

Parameters:

templateURL - Location of file containing the template body. The URL must point to a template (max size: 307,200 bytes) located in an S3 bucket in the same region as the stack. For more information, go to the AWS CloudFormation User Guide.

Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.

Returns:

A reference to this updated object so that method calls can be chained together.

getParameters

public List<Parameter> getParameters()

A list of Parameter structures that specify input parameters for the stack.

Returns:

A list of Parameter structures that specify input parameters for the stack.

setParameters

public void setParameters(Collection<Parameter> parameters)

A list of Parameter structures that specify input parameters for the stack.

Parameters:

parameters - A list of Parameter structures that specify input parameters for the stack.

withParameters

public CreateStackRequest withParameters(Parameter... parameters)

A list of Parameter structures that specify input parameters for the stack.

Returns a reference to this object so that method calls can be chained together.

Parameters:

parameters - A list of Parameter structures that specify input parameters for the stack.

Returns:

A reference to this updated object so that method calls can be chained together.

withParameters

public CreateStackRequest withParameters(Collection<Parameter> parameters)

A list of Parameter structures that specify input parameters for the stack.

Returns a reference to this object so that method calls can be chained together.

Parameters:

parameters - A list of Parameter structures that specify input parameters for the stack.

Returns:

A reference to this updated object so that method calls can be chained together.

isDisableRollback

public Boolean isDisableRollback()

Set to true to disable rollback of the stack if stack creation failed. You can specify either DisableRollback or OnFailure, but not both.

Default: false

Returns:

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

setDisableRollback

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

Parameters:

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

withDisableRollback

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getDisableRollback

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

Returns:

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

getTimeoutInMinutes

public Integer getTimeoutInMinutes()

The amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableRollback is not set or is set to false, the stack will be rolled back.

Constraints:
Range: 1 -

Returns:

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.

setTimeoutInMinutes

public void setTimeoutInMinutes(Integer timeoutInMinutes)

The amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableRollback is not set or is set to false, the stack will be rolled back.

Constraints:
Range: 1 -

Parameters:

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.

withTimeoutInMinutes

public CreateStackRequest withTimeoutInMinutes(Integer timeoutInMinutes)

The amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableRollback is not set or is set to false, the stack will be rolled back.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Range: 1 -

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

getNotificationARNs

public List<String> getNotificationARNs()

The Simple Notification Service (SNS) topic ARNs to publish stack related events. You can find your SNS topic ARNs using the SNS console or your Command Line Interface (CLI).

Constraints:
Length: 0 - 5

Returns:

The Simple Notification Service (SNS) topic ARNs to publish stack related events. You can find your SNS topic ARNs using the SNS console or your Command Line Interface (CLI).

setNotificationARNs

public void setNotificationARNs(Collection<String> notificationARNs)

The Simple Notification Service (SNS) topic ARNs to publish stack related events. You can find your SNS topic ARNs using the SNS console or your Command Line Interface (CLI).

Constraints:
Length: 0 - 5

Parameters:

notificationARNs - The Simple Notification Service (SNS) topic ARNs to publish stack related events. You can find your SNS topic ARNs using the SNS console or your Command Line Interface (CLI).

withNotificationARNs

public CreateStackRequest withNotificationARNs(String... notificationARNs)

The Simple Notification Service (SNS) topic ARNs to publish stack related events. You can find your SNS topic ARNs using the SNS console or your Command Line Interface (CLI).

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 0 - 5

Parameters:

notificationARNs - The Simple Notification Service (SNS) topic ARNs to publish stack related events. You can find your SNS topic ARNs using the SNS console or your Command Line Interface (CLI).

Returns:

A reference to this updated object so that method calls can be chained together.

withNotificationARNs

public CreateStackRequest withNotificationARNs(Collection<String> notificationARNs)

The Simple Notification Service (SNS) topic ARNs to publish stack related events. You can find your SNS topic ARNs using the SNS console or your Command Line Interface (CLI).

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 0 - 5

Parameters:

notificationARNs - The Simple Notification Service (SNS) topic ARNs to publish stack related events. You can find your SNS topic ARNs using the SNS console or your Command Line Interface (CLI).

Returns:

A reference to this updated object so that method calls can be chained together.

getCapabilities

public List<String> getCapabilities()

The list of capabilities that you want to allow in the stack. If your template contains IAM resources, you must specify the CAPABILITY_IAM value for this parameter; otherwise, this action returns an InsufficientCapabilities error. IAM resources are the following: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::Policy, AWS::IAM::User, and AWS::IAM::UserToGroupAddition.

Returns:

The list of capabilities that you want to allow in the stack. If your template contains IAM resources, you must specify the CAPABILITY_IAM value for this parameter; otherwise, this action returns an InsufficientCapabilities error. IAM resources are the following: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::Policy, AWS::IAM::User, and AWS::IAM::UserToGroupAddition.

setCapabilities

public void setCapabilities(Collection<String> capabilities)

The list of capabilities that you want to allow in the stack. If your template contains IAM resources, you must specify the CAPABILITY_IAM value for this parameter; otherwise, this action returns an InsufficientCapabilities error. IAM resources are the following: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::Policy, AWS::IAM::User, and AWS::IAM::UserToGroupAddition.

Parameters:

capabilities - The list of capabilities that you want to allow in the stack. If your template contains IAM resources, you must specify the CAPABILITY_IAM value for this parameter; otherwise, this action returns an InsufficientCapabilities error. IAM resources are the following: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::Policy, AWS::IAM::User, and AWS::IAM::UserToGroupAddition.

withCapabilities

public CreateStackRequest withCapabilities(String... capabilities)

The list of capabilities that you want to allow in the stack. If your template contains IAM resources, you must specify the CAPABILITY_IAM value for this parameter; otherwise, this action returns an InsufficientCapabilities error. IAM resources are the following: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::Policy, AWS::IAM::User, and AWS::IAM::UserToGroupAddition.

Returns a reference to this object so that method calls can be chained together.

Parameters:

capabilities - The list of capabilities that you want to allow in the stack. If your template contains IAM resources, you must specify the CAPABILITY_IAM value for this parameter; otherwise, this action returns an InsufficientCapabilities error. IAM resources are the following: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::Policy, AWS::IAM::User, and AWS::IAM::UserToGroupAddition.

Returns:

A reference to this updated object so that method calls can be chained together.

withCapabilities

public CreateStackRequest withCapabilities(Collection<String> capabilities)

The list of capabilities that you want to allow in the stack. If your template contains IAM resources, you must specify the CAPABILITY_IAM value for this parameter; otherwise, this action returns an InsufficientCapabilities error. IAM resources are the following: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::Policy, AWS::IAM::User, and AWS::IAM::UserToGroupAddition.

Returns a reference to this object so that method calls can be chained together.

Parameters:

capabilities - The list of capabilities that you want to allow in the stack. If your template contains IAM resources, you must specify the CAPABILITY_IAM value for this parameter; otherwise, this action returns an InsufficientCapabilities error. IAM resources are the following: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::Policy, AWS::IAM::User, and AWS::IAM::UserToGroupAddition.

Returns:

A reference to this updated object so that method calls can be chained together.

getOnFailure

public String getOnFailure()

Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify either OnFailure or DisableRollback, but not both.

Default: ROLLBACK

Constraints:
Allowed Values: DO_NOTHING, ROLLBACK, DELETE

Returns:

Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify either OnFailure or DisableRollback, but not both.

Default: ROLLBACK

See Also:

OnFailure

setOnFailure

public void setOnFailure(String onFailure)

Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify either OnFailure or DisableRollback, but not both.

Default: ROLLBACK

Constraints:
Allowed Values: DO_NOTHING, ROLLBACK, DELETE

Parameters:

onFailure - Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify either OnFailure or DisableRollback, but not both.

Default: ROLLBACK

See Also:

OnFailure

withOnFailure

public CreateStackRequest withOnFailure(String onFailure)

Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify either OnFailure or DisableRollback, but not both.

Default: ROLLBACK

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: DO_NOTHING, ROLLBACK, DELETE

Parameters:

onFailure - Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify either OnFailure or DisableRollback, but not both.

Default: ROLLBACK

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

OnFailure

setOnFailure

public void setOnFailure(OnFailure onFailure)

Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify either OnFailure or DisableRollback, but not both.

Default: ROLLBACK

Constraints:
Allowed Values: DO_NOTHING, ROLLBACK, DELETE

Parameters:

onFailure - Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify either OnFailure or DisableRollback, but not both.

Default: ROLLBACK

See Also:

OnFailure

withOnFailure

public CreateStackRequest withOnFailure(OnFailure onFailure)

Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify either OnFailure or DisableRollback, but not both.

Default: ROLLBACK

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: DO_NOTHING, ROLLBACK, DELETE

Parameters:

onFailure - Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify either OnFailure or DisableRollback, but not both.

Default: ROLLBACK

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

OnFailure

getTags

public List<Tag> getTags()

A set of user-defined Tags to associate with this stack, represented by key/value pairs. Tags defined for the stack are propogated to EC2 resources that are created as part of the stack. A maximum number of 10 tags can be specified.

Returns:

A set of user-defined Tags to associate with this stack, represented by key/value pairs. Tags defined for the stack are propogated to EC2 resources that are created as part of the stack. A maximum number of 10 tags can be specified.

setTags

public void setTags(Collection<Tag> tags)

A set of user-defined Tags to associate with this stack, represented by key/value pairs. Tags defined for the stack are propogated to EC2 resources that are created as part of the stack. A maximum number of 10 tags can be specified.

Parameters:

tags - A set of user-defined Tags to associate with this stack, represented by key/value pairs. Tags defined for the stack are propogated to EC2 resources that are created as part of the stack. A maximum number of 10 tags can be specified.

withTags

public CreateStackRequest withTags(Tag... tags)

A set of user-defined Tags to associate with this stack, represented by key/value pairs. Tags defined for the stack are propogated to EC2 resources that are created as part of the stack. A maximum number of 10 tags can be specified.

Returns a reference to this object so that method calls can be chained together.

Parameters:

tags - A set of user-defined Tags to associate with this stack, represented by key/value pairs. Tags defined for the stack are propogated to EC2 resources that are created as part of the stack. A maximum number of 10 tags can be specified.

Returns:

A reference to this updated object so that method calls can be chained together.

withTags

public CreateStackRequest withTags(Collection<Tag> tags)

A set of user-defined Tags to associate with this stack, represented by key/value pairs. Tags defined for the stack are propogated to EC2 resources that are created as part of the stack. A maximum number of 10 tags can be specified.

Returns a reference to this object so that method calls can be chained together.

Parameters:

tags - A set of user-defined Tags to associate with this stack, represented by key/value pairs. Tags defined for the stack are propogated to EC2 resources that are created as part of the stack. A maximum number of 10 tags can be specified.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object