@Generated(value="software.amazon.awssdk:codegen") public final class CreateStackRequest extends CloudFormationRequest implements ToCopyableBuilder<CreateStackRequest.Builder,CreateStackRequest>
The input for CreateStack action.
Modifier and Type | Class and Description |
---|---|
static interface |
CreateStackRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static CreateStackRequest.Builder |
builder() |
List<Capability> |
capabilities()
A list of values that you must specify before AWS CloudFormation can create certain stacks.
|
List<String> |
capabilitiesAsStrings()
A list of values that you must specify before AWS CloudFormation can create certain stacks.
|
String |
clientRequestToken()
A unique identifier for this
CreateStack request. |
Boolean |
disableRollback()
Set to
true to disable rollback of the stack if stack creation failed. |
Boolean |
enableTerminationProtection()
Whether to enable termination protection on the specified stack.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
List<String> |
notificationARNs()
The Simple Notification Service (SNS) topic ARNs to publish stack related events.
|
OnFailure |
onFailure()
Determines what action will be taken if stack creation fails.
|
String |
onFailureAsString()
Determines what action will be taken if stack creation fails.
|
List<Parameter> |
parameters()
A list of
Parameter structures that specify input parameters for the stack. |
List<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 . |
String |
roleARN()
The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation
assumes to create the stack.
|
RollbackConfiguration |
rollbackConfiguration()
The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for
the specified monitoring period afterwards.
|
static Class<? extends CreateStackRequest.Builder> |
serializableBuilderClass() |
String |
stackName()
The name that is associated with the stack.
|
String |
stackPolicyBody()
Structure containing the stack policy body.
|
String |
stackPolicyURL()
Location of a file containing the stack policy.
|
List<Tag> |
tags()
Key-value pairs to associate with this stack.
|
String |
templateBody()
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.
|
String |
templateURL()
Location of file containing the template body.
|
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. |
CreateStackRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
overrideConfiguration
copy
public String stackName()
The name that is associated with the stack. The name must be unique in the region in which you are creating the stack.
A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an alphabetic character and cannot be longer than 128 characters.
A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an alphabetic character and cannot be longer than 128 characters.
public String 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.
Conditional: You must specify either the TemplateBody
or the TemplateURL
parameter, but not both.
public String templateURL()
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, go to the Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must specify either the TemplateBody
or the TemplateURL
parameter, but
not both.
Conditional: You must specify either the TemplateBody
or the TemplateURL
parameter, but not both.
public List<Parameter> parameters()
A list of Parameter
structures that specify input parameters for the stack. For more information,
see the Parameter data
type.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
Parameter
structures that specify input parameters for the stack. For more
information, see the Parameter
data type.public 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
true
to disable rollback of the stack if stack creation failed. You can specify
either DisableRollback
or OnFailure
, but not both.
Default: false
public RollbackConfiguration rollbackConfiguration()
The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
public 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.
DisableRollback
is not set or is set to false
, the stack will be rolled back.public List<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).
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<Capability> capabilities()
A list of values that you must specify before AWS CloudFormation can create certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.
The only valid values are CAPABILITY_IAM
and CAPABILITY_NAMED_IAM
. The following
resources require you to specify this parameter:
AWS::IAM::AccessKey,
AWS::IAM::Group,
AWS::IAM::InstanceProfile,
AWS::IAM::Policy,
AWS::IAM::Role,
AWS::IAM::User, and
AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review
all permissions associated with them and edit their permissions if necessary.
If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you
must specify CAPABILITY_NAMED_IAM
. If you don't specify this parameter, this action returns an
InsufficientCapabilities
error.
For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
The only valid values are CAPABILITY_IAM
and CAPABILITY_NAMED_IAM
. The
following resources require you to specify this parameter:
AWS::IAM::AccessKey,
AWS::IAM::Group,
AWS::IAM::InstanceProfile,
AWS::IAM::Policy,
AWS::IAM::Role,
AWS::IAM::User, and
AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you
review all permissions associated with them and edit their permissions if necessary.
If you have IAM resources, you can specify either capability. If you have IAM resources with custom
names, you must specify CAPABILITY_NAMED_IAM
. If you don't specify this parameter, this
action returns an InsufficientCapabilities
error.
For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
public List<String> capabilitiesAsStrings()
A list of values that you must specify before AWS CloudFormation can create certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.
The only valid values are CAPABILITY_IAM
and CAPABILITY_NAMED_IAM
. The following
resources require you to specify this parameter:
AWS::IAM::AccessKey,
AWS::IAM::Group,
AWS::IAM::InstanceProfile,
AWS::IAM::Policy,
AWS::IAM::Role,
AWS::IAM::User, and
AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review
all permissions associated with them and edit their permissions if necessary.
If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you
must specify CAPABILITY_NAMED_IAM
. If you don't specify this parameter, this action returns an
InsufficientCapabilities
error.
For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
The only valid values are CAPABILITY_IAM
and CAPABILITY_NAMED_IAM
. The
following resources require you to specify this parameter:
AWS::IAM::AccessKey,
AWS::IAM::Group,
AWS::IAM::InstanceProfile,
AWS::IAM::Policy,
AWS::IAM::Role,
AWS::IAM::User, and
AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you
review all permissions associated with them and edit their permissions if necessary.
If you have IAM resources, you can specify either capability. If you have IAM resources with custom
names, you must specify CAPABILITY_NAMED_IAM
. If you don't specify this parameter, this
action returns an InsufficientCapabilities
error.
For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
public List<String> resourceTypes()
The template resource types that you have permissions to work with for this create stack action, such as
AWS::EC2::Instance
, AWS::EC2::*
, or Custom::MyCustomInstance
. Use the
following syntax to describe template resource types: AWS::*
(for all AWS resource),
Custom::*
(for all custom resources), Custom::logical_ID
(for a specific custom
resource), AWS::service_name::*
(for all resources of a particular AWS service), and
AWS::service_name::resource_logical_ID
(for a specific AWS resource).
If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with AWS Identity and Access Management.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
AWS::EC2::Instance
, AWS::EC2::*
, or Custom::MyCustomInstance
. Use
the following syntax to describe template resource types: AWS::*
(for all AWS resource),
Custom::*
(for all custom resources), Custom::logical_ID
(for a
specific custom resource), AWS::service_name::*
(for all resources of a particular
AWS service), and AWS::service_name::resource_logical_ID
(for a specific AWS
resource).
If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with AWS Identity and Access Management.
public String roleARN()
The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to create the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.
If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.
If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.
public 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
If the service returns an enum value that is not available in the current SDK version, onFailure
will
return OnFailure.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
onFailureAsString()
.
OnFailure
or DisableRollback
, but not
both.
Default: ROLLBACK
OnFailure
public String onFailureAsString()
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
If the service returns an enum value that is not available in the current SDK version, onFailure
will
return OnFailure.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
onFailureAsString()
.
OnFailure
or DisableRollback
, but not
both.
Default: ROLLBACK
OnFailure
public String stackPolicyBody()
Structure containing the stack policy body. For more information, go to Prevent
Updates to Stack Resources in the AWS CloudFormation User Guide. You can specify either the
StackPolicyBody
or the StackPolicyURL
parameter, but not both.
StackPolicyBody
or the StackPolicyURL
parameter, but not both.public String stackPolicyURL()
Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in
an S3 bucket in the same region as the stack. You can specify either the StackPolicyBody
or the
StackPolicyURL
parameter, but not both.
StackPolicyBody
or the StackPolicyURL
parameter, but not both.public List<Tag> tags()
Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 50 tags can be specified.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public String clientRequestToken()
A unique identifier for this CreateStack
request. Specify this token if you plan to retry requests
so that AWS CloudFormation knows that you're not attempting to create a stack with the same name. You might retry
CreateStack
requests to ensure that AWS CloudFormation successfully received them.
All events triggered by a given stack operation are assigned the same client request token, which you can use to
track operations. For example, if you execute a CreateStack
operation with the token
token1
, then all the StackEvents
generated by that operation will have
ClientRequestToken
set as token1
.
In the console, stack operations display the client request token on the Events tab. Stack operations that are
initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify
the stack operation . For example, if you create a stack using the console, each stack event would be assigned
the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002
.
CreateStack
request. Specify this token if you plan to retry
requests so that AWS CloudFormation knows that you're not attempting to create a stack with the same
name. You might retry CreateStack
requests to ensure that AWS CloudFormation successfully
received them.
All events triggered by a given stack operation are assigned the same client request token, which you can
use to track operations. For example, if you execute a CreateStack
operation with the token
token1
, then all the StackEvents
generated by that operation will have
ClientRequestToken
set as token1
.
In the console, stack operations display the client request token on the Events tab. Stack operations
that are initiated from the console use the token format Console-StackOperation-ID, which helps
you easily identify the stack operation . For example, if you create a stack using the console, each
stack event would be assigned the same token in the following format:
Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002
.
public Boolean enableTerminationProtection()
Whether to enable termination protection on the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide. Termination protection is disabled on stacks by default.
For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack.
For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack.
public CreateStackRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreateStackRequest.Builder,CreateStackRequest>
toBuilder
in class CloudFormationRequest
public static CreateStackRequest.Builder builder()
public static Class<? extends CreateStackRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.