public class CreateStackRequest extends AmazonWebServiceRequest implements Serializable
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.
NOOP
Constructor and Description |
---|
CreateStackRequest() |
Modifier and Type | Method and Description |
---|---|
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.
|
String |
getStackPolicyBody()
Structure containing the stack policy body.
|
String |
getStackPolicyURL()
Location of a file containing the stack policy.
|
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 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. |
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 |
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)
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 with a minimum length of 1 byte
and a maximum length of 51,200 bytes.
|
void |
setTemplateURL(String templateURL)
Location of file containing the template body.
|
void |
setTimeoutInMinutes(Integer timeoutInMinutes)
The amount of time that can pass before the stack status becomes
CREATE_FAILED; if
DisableRollback is not set or is set to
false , the stack will be rolled back. |
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
CreateStackRequest |
withCapabilities(Capability... capabilities)
The list of capabilities that you want to allow in the stack.
|
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 |
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)
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 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. |
copyPrivateRequestParameters, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public String getStackName()
public void setStackName(String stackName)
stackName
- The name associated with the stack. The name must be unique within
your AWS account. public CreateStackRequest withStackName(String stackName)
Returns a reference to this object so that method calls can be chained together.
stackName
- The name associated with the stack. The name must be unique within
your AWS account. public String getTemplateBody()
Conditional: You
must specify either the TemplateBody
or the
TemplateURL
parameter, but not both.
Constraints:
Length: 1 -
Conditional: You
must specify either the TemplateBody
or the
TemplateURL
parameter, but not both.
public void setTemplateBody(String templateBody)
Conditional: You
must specify either the TemplateBody
or the
TemplateURL
parameter, but not both.
Constraints:
Length: 1 -
templateBody
- Structure containing the template body with a minimum length of 1 byte
and a maximum length of 51,200 bytes. For more information, go to Template
Anatomy in the AWS CloudFormation User Guide. Conditional: You
must specify either the TemplateBody
or the
TemplateURL
parameter, but not both.
public CreateStackRequest withTemplateBody(String templateBody)
Conditional: You
must specify either the TemplateBody
or the
TemplateURL
parameter, but not both.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 -
templateBody
- Structure containing the template body with a minimum length of 1 byte
and a maximum length of 51,200 bytes. For more information, go to Template
Anatomy in the AWS CloudFormation User Guide. Conditional: You
must specify either the TemplateBody
or the
TemplateURL
parameter, but not both.
public String getTemplateURL()
Conditional: You
must specify either the TemplateBody
or the
TemplateURL
parameter, but not both.
Constraints:
Length: 1 - 1024
Conditional: You
must specify either the TemplateBody
or the
TemplateURL
parameter, but not both.
public void setTemplateURL(String templateURL)
Conditional: You
must specify either the TemplateBody
or the
TemplateURL
parameter, but not both.
Constraints:
Length: 1 - 1024
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 Template
Anatomy in the AWS CloudFormation User Guide. Conditional: You
must specify either the TemplateBody
or the
TemplateURL
parameter, but not both.
public CreateStackRequest withTemplateURL(String templateURL)
Conditional: You
must specify either the TemplateBody
or the
TemplateURL
parameter, but not both.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 1024
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 Template
Anatomy in the AWS CloudFormation User Guide. Conditional: You
must specify either the TemplateBody
or the
TemplateURL
parameter, but not both.
public List<Parameter> getParameters()
Parameter
structures that specify input
parameters for the stack.Parameter
structures that specify input
parameters for the stack.public void setParameters(Collection<Parameter> parameters)
Parameter
structures that specify input
parameters for the stack.parameters
- A list of Parameter
structures that specify input
parameters for the stack.public CreateStackRequest withParameters(Parameter... parameters)
Parameter
structures that specify input
parameters for the stack.
Returns a reference to this object so that method calls can be chained together.
parameters
- A list of Parameter
structures that specify input
parameters for the stack.public CreateStackRequest withParameters(Collection<Parameter> parameters)
Parameter
structures that specify input
parameters for the stack.
Returns a reference to this object so that method calls can be chained together.
parameters
- A list of Parameter
structures that specify input
parameters for the stack.public Boolean isDisableRollback()
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 setDisableRollback(Boolean disableRollback)
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 CreateStackRequest withDisableRollback(Boolean disableRollback)
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.
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()
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 Integer getTimeoutInMinutes()
DisableRollback
is not set or is set to
false
, the stack will be rolled back.
Constraints:
Range: 1 -
DisableRollback
is not set or is set to
false
, the stack will be rolled back.public void setTimeoutInMinutes(Integer timeoutInMinutes)
DisableRollback
is not set or is set to
false
, the stack will be rolled back.
Constraints:
Range: 1 -
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 CreateStackRequest withTimeoutInMinutes(Integer timeoutInMinutes)
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 -
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()
Constraints:
Length: 0 - 5
public void setNotificationARNs(Collection<String> notificationARNs)
Constraints:
Length: 0 - 5
notificationARNs
- The Simple Notification Service (SNS) topic ARNs to publish stack
related events. You can find your SNS topic ARNs using the SNS console or your
Command Line Interface (CLI).public CreateStackRequest withNotificationARNs(String... notificationARNs)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 5
notificationARNs
- The Simple Notification Service (SNS) topic ARNs to publish stack
related events. You can find your SNS topic ARNs using the SNS console or your
Command Line Interface (CLI).public CreateStackRequest withNotificationARNs(Collection<String> notificationARNs)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 5
notificationARNs
- The Simple Notification Service (SNS) topic ARNs to publish stack
related events. You can find your SNS topic ARNs using the SNS console or your
Command Line Interface (CLI).public List<String> getCapabilities()
public void setCapabilities(Collection<String> capabilities)
capabilities
- The list of capabilities that you want to allow in the stack. If your
template contains certain resources, you must specify the
CAPABILITY_IAM value for this parameter; otherwise, this action
returns an InsufficientCapabilities error. The following resources
require you to specify the capabilities parameter: AWS::CloudFormation::Stack,
AWS::IAM::AccessKey,
AWS::IAM::Group,
AWS::IAM::InstanceProfile,
AWS::IAM::Policy,
AWS::IAM::Role,
AWS::IAM::User,
and AWS::IAM::UserToGroupAddition.public CreateStackRequest withCapabilities(String... capabilities)
Returns a reference to this object so that method calls can be chained together.
capabilities
- The list of capabilities that you want to allow in the stack. If your
template contains certain resources, you must specify the
CAPABILITY_IAM value for this parameter; otherwise, this action
returns an InsufficientCapabilities error. The following resources
require you to specify the capabilities parameter: AWS::CloudFormation::Stack,
AWS::IAM::AccessKey,
AWS::IAM::Group,
AWS::IAM::InstanceProfile,
AWS::IAM::Policy,
AWS::IAM::Role,
AWS::IAM::User,
and AWS::IAM::UserToGroupAddition.public CreateStackRequest withCapabilities(Collection<String> capabilities)
Returns a reference to this object so that method calls can be chained together.
capabilities
- The list of capabilities that you want to allow in the stack. If your
template contains certain resources, you must specify the
CAPABILITY_IAM value for this parameter; otherwise, this action
returns an InsufficientCapabilities error. The following resources
require you to specify the capabilities parameter: AWS::CloudFormation::Stack,
AWS::IAM::AccessKey,
AWS::IAM::Group,
AWS::IAM::InstanceProfile,
AWS::IAM::Policy,
AWS::IAM::Role,
AWS::IAM::User,
and AWS::IAM::UserToGroupAddition.public CreateStackRequest withCapabilities(Capability... capabilities)
Returns a reference to this object so that method calls can be chained together.
capabilities
- The list of capabilities that you want to allow in the stack. If your
template contains certain resources, you must specify the
CAPABILITY_IAM value for this parameter; otherwise, this action
returns an InsufficientCapabilities error. The following resources
require you to specify the capabilities parameter: AWS::CloudFormation::Stack,
AWS::IAM::AccessKey,
AWS::IAM::Group,
AWS::IAM::InstanceProfile,
AWS::IAM::Policy,
AWS::IAM::Role,
AWS::IAM::User,
and AWS::IAM::UserToGroupAddition.public String getOnFailure()
OnFailure
or DisableRollback
, but not
both. Default: ROLLBACK
Constraints:
Allowed Values: DO_NOTHING, ROLLBACK, DELETE
OnFailure
or DisableRollback
, but not
both. Default: ROLLBACK
OnFailure
public void setOnFailure(String onFailure)
OnFailure
or DisableRollback
, but not
both. Default: ROLLBACK
Constraints:
Allowed Values: DO_NOTHING, ROLLBACK, DELETE
onFailure
- Determines what action will be taken if stack creation fails. This
must be one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify
either OnFailure
or DisableRollback
, but not
both. Default: ROLLBACK
OnFailure
public CreateStackRequest withOnFailure(String onFailure)
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
onFailure
- Determines what action will be taken if stack creation fails. This
must be one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify
either OnFailure
or DisableRollback
, but not
both. Default: ROLLBACK
OnFailure
public void setOnFailure(OnFailure onFailure)
OnFailure
or DisableRollback
, but not
both. Default: ROLLBACK
Constraints:
Allowed Values: DO_NOTHING, ROLLBACK, DELETE
onFailure
- Determines what action will be taken if stack creation fails. This
must be one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify
either OnFailure
or DisableRollback
, but not
both. Default: ROLLBACK
OnFailure
public CreateStackRequest withOnFailure(OnFailure onFailure)
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
onFailure
- Determines what action will be taken if stack creation fails. This
must be one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify
either OnFailure
or DisableRollback
, but not
both. Default: ROLLBACK
OnFailure
public String getStackPolicyBody()
StackPolicyBody
or the
StackPolicyURL
parameter, but not both.
Constraints:
Length: 1 - 16384
StackPolicyBody
or the
StackPolicyURL
parameter, but not both.public void setStackPolicyBody(String stackPolicyBody)
StackPolicyBody
or the
StackPolicyURL
parameter, but not both.
Constraints:
Length: 1 - 16384
stackPolicyBody
- Structure containing the stack policy body. For more information, go
to
Prevent Updates to Stack Resources in the AWS CloudFormation User
Guide. You can specify either the StackPolicyBody
or the
StackPolicyURL
parameter, but not both.public CreateStackRequest withStackPolicyBody(String stackPolicyBody)
StackPolicyBody
or the
StackPolicyURL
parameter, but not both.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 16384
stackPolicyBody
- Structure containing the stack policy body. For more information, go
to
Prevent Updates to Stack Resources in the AWS CloudFormation User
Guide. You can specify either the StackPolicyBody
or the
StackPolicyURL
parameter, but not both.public String getStackPolicyURL()
StackPolicyBody
or the StackPolicyURL
parameter, but not both.
Constraints:
Length: 1 - 1350
StackPolicyBody
or the StackPolicyURL
parameter, but not both.public void setStackPolicyURL(String stackPolicyURL)
StackPolicyBody
or the StackPolicyURL
parameter, but not both.
Constraints:
Length: 1 - 1350
stackPolicyURL
- Location of a file containing the stack policy. The URL must point to
a policy (max size: 16KB) located in an S3 bucket in the same region
as the stack. You can specify either the StackPolicyBody
or the StackPolicyURL
parameter, but not both.public CreateStackRequest withStackPolicyURL(String stackPolicyURL)
StackPolicyBody
or the StackPolicyURL
parameter, but not both.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 1350
stackPolicyURL
- Location of a file containing the stack policy. The URL must point to
a policy (max size: 16KB) located in an S3 bucket in the same region
as the stack. You can specify either the StackPolicyBody
or the StackPolicyURL
parameter, but not both.public List<Tag> getTags()
Tags
to associate with this stack,
represented by key/value pairs. Tags defined for the stack are
propagated to EC2 resources that are created as part of the stack. A
maximum number of 10 tags can be specified.Tags
to associate with this stack,
represented by key/value pairs. Tags defined for the stack are
propagated to EC2 resources that are created as part of the stack. A
maximum number of 10 tags can be specified.public void setTags(Collection<Tag> tags)
Tags
to associate with this stack,
represented by key/value pairs. Tags defined for the stack are
propagated to EC2 resources that are created as part of the stack. A
maximum number of 10 tags can be specified.tags
- A set of user-defined Tags
to associate with this stack,
represented by key/value pairs. Tags defined for the stack are
propagated to EC2 resources that are created as part of the stack. A
maximum number of 10 tags can be specified.public CreateStackRequest withTags(Tag... tags)
Tags
to associate with this stack,
represented by key/value pairs. Tags defined for the stack are
propagated 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.
tags
- A set of user-defined Tags
to associate with this stack,
represented by key/value pairs. Tags defined for the stack are
propagated to EC2 resources that are created as part of the stack. A
maximum number of 10 tags can be specified.public CreateStackRequest withTags(Collection<Tag> tags)
Tags
to associate with this stack,
represented by key/value pairs. Tags defined for the stack are
propagated 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.
tags
- A set of user-defined Tags
to associate with this stack,
represented by key/value pairs. Tags defined for the stack are
propagated to EC2 resources that are created as part of the stack. A
maximum number of 10 tags can be specified.public String toString()
toString
in class Object
Object.toString()
Copyright © 2014. All rights reserved.