Class CreateStackRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateStackRequest.Builder,
CreateStackRequest>
The input for CreateStack action.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic CreateStackRequest.Builder
builder()
final List
<Capability> In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.final String
A unique identifier for thisCreateStack
request.final Boolean
Set totrue
to disable rollback of the stack if stack creation failed.final Boolean
Whether to enable termination protection on the specified stack.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the Capabilities property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the NotificationARNs property.final boolean
For responses, this returns true if the service returned a value for the Parameters property.final boolean
For responses, this returns true if the service returned a value for the ResourceTypes property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.The Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish stack related events.final OnFailure
Determines what action will be taken if stack creation fails.final String
Determines what action will be taken if stack creation fails.A list ofParameter
structures that specify input parameters for the stack.The template resource types that you have permissions to work with for this create stack action, such asAWS::EC2::Instance
,AWS::EC2::*
, orCustom::MyCustomInstance
.final Boolean
When set totrue
, newly created resources are deleted when the operation rolls back.final String
roleARN()
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to create the stack.final RollbackConfiguration
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.static Class
<? extends CreateStackRequest.Builder> final String
The name that's associated with the stack.final String
Structure containing the stack policy body.final String
Location of a file containing the stack policy.tags()
Key-value pairs to associate with this stack.final String
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.final String
Location of file containing the template body.final Integer
The amount of time that can pass before the stack status becomesCREATE_FAILED
; ifDisableRollback
is not set or is set tofalse
, the stack will be rolled back.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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.
- Returns:
- 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.
-
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 theTemplateURL
parameter, but not both.- Returns:
- 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 theTemplateURL
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 theTemplateURL
parameter, but not both.- Returns:
- 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 theTemplateURL
parameter, but not both.
-
hasParameters
public final boolean hasParameters()For responses, this returns true if the service returned a value for the Parameters property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasParameters()
method.- Returns:
- A list of
Parameter
structures that specify input parameters for the stack. For more information, see the Parameter data type.
-
disableRollback
Set to
true
to disable rollback of the stack if stack creation failed. You can specify eitherDisableRollback
orOnFailure
, but not both.Default:
false
- Returns:
- Set to
true
to disable rollback of the stack if stack creation failed. You can specify eitherDisableRollback
orOnFailure
, but not both.Default:
false
-
rollbackConfiguration
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
- Returns:
- The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
-
timeoutInMinutes
The amount of time that can pass before the stack status becomes
CREATE_FAILED
; ifDisableRollback
is not set or is set tofalse
, the stack will be rolled back.- Returns:
- The amount of time that can pass before the stack status becomes
CREATE_FAILED
; ifDisableRollback
is not set or is set tofalse
, the stack will be rolled back.
-
hasNotificationARNs
public final boolean hasNotificationARNs()For responses, this returns true if the service returned a value for the NotificationARNs property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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).
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasNotificationARNs()
method.- Returns:
- 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).
-
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
andCAPABILITY_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
orCAPABILITY_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
andResourceType
parameters can be specified.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasCapabilities()
method.- Returns:
- In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in
order for CloudFormation to create the stack.
-
CAPABILITY_IAM
andCAPABILITY_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
orCAPABILITY_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
andResourceType
parameters can be specified. -
-
-
hasCapabilities
public final boolean hasCapabilities()For responses, this returns true if the service returned a value for the Capabilities property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
capabilitiesAsStrings
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.
-
CAPABILITY_IAM
andCAPABILITY_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
orCAPABILITY_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
andResourceType
parameters can be specified.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasCapabilities()
method.- Returns:
- In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in
order for CloudFormation to create the stack.
-
CAPABILITY_IAM
andCAPABILITY_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
orCAPABILITY_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
andResourceType
parameters can be specified. -
-
-
hasResourceTypes
public final boolean hasResourceTypes()For responses, this returns true if the service returned a value for the ResourceTypes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not 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::*
, orCustom::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), andAWS::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
andResourceType
parameters can be specified.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasResourceTypes()
method.- Returns:
- The template resource types that you have permissions to work with for this create stack action, such as
AWS::EC2::Instance
,AWS::EC2::*
, orCustom::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), andAWS::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
andResourceType
parameters can be specified.
-
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.
- Returns:
- 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.
-
onFailure
Determines what action will be taken if stack creation fails. This must be one of:
DO_NOTHING
,ROLLBACK
, orDELETE
. You can specify eitherOnFailure
orDisableRollback
, but not both.Default:
ROLLBACK
If the service returns an enum value that is not available in the current SDK version,
onFailure
will returnOnFailure.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromonFailureAsString()
.- Returns:
- Determines what action will be taken if stack creation fails. This must be one of:
DO_NOTHING
,ROLLBACK
, orDELETE
. You can specify eitherOnFailure
orDisableRollback
, but not both.Default:
ROLLBACK
- See Also:
-
onFailureAsString
Determines what action will be taken if stack creation fails. This must be one of:
DO_NOTHING
,ROLLBACK
, orDELETE
. You can specify eitherOnFailure
orDisableRollback
, but not both.Default:
ROLLBACK
If the service returns an enum value that is not available in the current SDK version,
onFailure
will returnOnFailure.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromonFailureAsString()
.- Returns:
- Determines what action will be taken if stack creation fails. This must be one of:
DO_NOTHING
,ROLLBACK
, orDELETE
. You can specify eitherOnFailure
orDisableRollback
, but not both.Default:
ROLLBACK
- See Also:
-
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 theStackPolicyURL
parameter, but not both.- Returns:
- 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 theStackPolicyURL
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 theStackPolicyBody
or theStackPolicyURL
parameter, but not both.- Returns:
- 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 theStackPolicyBody
or theStackPolicyURL
parameter, but not both.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()
method.- Returns:
- 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.
-
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 retryCreateStack
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 tokentoken1
, then all theStackEvents
generated by that operation will haveClientRequestToken
set astoken1
.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
.- Returns:
- 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 retryCreateStack
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 tokentoken1
, then all theStackEvents
generated by that operation will haveClientRequestToken
set astoken1
.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
.
-
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.
- Returns:
- 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.
-
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 ofRetain
.Default:
false
- Returns:
- When set to
true
, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy ofRetain
.Default:
false
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateStackRequest.Builder,
CreateStackRequest> - Specified by:
toBuilder
in classCloudFormationRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-