Class Stack
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Stack.Builder,
Stack>
The Stack data type.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Stack.Builder
builder()
final List
<Capability> The capabilities allowed in the stack.The capabilities allowed in the stack.final String
The unique ID of the change set.final Instant
The time at which the stack was created.final Instant
The time the stack was deleted.final String
A user-defined description associated with the stack.final DetailedStatus
The detailed status of the resource or stack.final String
The detailed status of the resource or stack.final Boolean
Boolean to enable or disable rollback on stack creation failures:final StackDriftInformation
Information about whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters.final Boolean
Whether termination protection is enabled for the 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) 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 Outputs property.final boolean
For responses, this returns true if the service returned a value for the Parameters property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final Instant
The time the stack was last updated.Amazon SNS topic Amazon Resource Names (ARNs) to which stack related events are published.outputs()
A list of output structures.A list ofParameter
structures.final String
parentId()
For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack.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's associated with the stack.final RollbackConfiguration
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.final String
rootId()
For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which the nested stack ultimately belongs.static Class
<? extends Stack.Builder> final String
stackId()
Unique identifier of the stack.final String
The name associated with the stack.final StackStatus
Current status of the stack.final String
Current status of the stack.final String
Success/failure message associated with the stack status.tags()
A list ofTag
s that specify information about the stack.final Integer
The amount of time within which stack creation should complete.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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
stackId
Unique identifier of the stack.
- Returns:
- Unique identifier of the stack.
-
stackName
The name associated with the stack.
- Returns:
- The name associated with the stack.
-
changeSetId
The unique ID of the change set.
- Returns:
- The unique ID of the change set.
-
description
A user-defined description associated with the stack.
- Returns:
- A user-defined description associated with the stack.
-
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.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.
-
creationTime
The time at which the stack was created.
- Returns:
- The time at which the stack was created.
-
deletionTime
The time the stack was deleted.
- Returns:
- The time the stack was deleted.
-
lastUpdatedTime
The time the stack was last updated. This field will only be returned if the stack has been updated at least once.
- Returns:
- The time the stack was last updated. This field will only be returned if the stack has been updated at least once.
-
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.
-
stackStatus
Current status of the stack.
If the service returns an enum value that is not available in the current SDK version,
stackStatus
will returnStackStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstackStatusAsString()
.- Returns:
- Current status of the stack.
- See Also:
-
stackStatusAsString
Current status of the stack.
If the service returns an enum value that is not available in the current SDK version,
stackStatus
will returnStackStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstackStatusAsString()
.- Returns:
- Current status of the stack.
- See Also:
-
stackStatusReason
Success/failure message associated with the stack status.
- Returns:
- Success/failure message associated with the stack status.
-
disableRollback
Boolean to enable or disable rollback on stack creation failures:
-
true
: disable rollback. -
false
: enable rollback.
- Returns:
- Boolean to enable or disable rollback on stack creation failures:
-
true
: disable rollback. -
false
: enable rollback.
-
-
-
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
Amazon SNS topic Amazon Resource Names (ARNs) to which stack related events are published.
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:
- Amazon SNS topic Amazon Resource Names (ARNs) to which stack related events are published.
-
timeoutInMinutes
The amount of time within which stack creation should complete.
- Returns:
- The amount of time within which stack creation should complete.
-
capabilities
The capabilities allowed in the stack.
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:
- The capabilities allowed in the stack.
-
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
The capabilities allowed in the stack.
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:
- The capabilities allowed in the stack.
-
hasOutputs
public final boolean hasOutputs()For responses, this returns true if the service returned a value for the Outputs 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. -
outputs
A list of output structures.
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
hasOutputs()
method.- Returns:
- A list of output structures.
-
roleARN
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that's associated with the stack. During a stack operation, CloudFormation uses this role's credentials to make calls on your behalf.
- Returns:
- The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that's associated with the stack. During a stack operation, CloudFormation uses this role's credentials to make calls on your behalf.
-
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
A list of
Tag
s that specify information about the stack.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:
- A list of
Tag
s that specify information about the stack.
-
enableTerminationProtection
Whether termination protection is enabled for the stack.
For nested stacks, termination protection is set on the root stack and can't be changed directly on the nested stack. For more information, see Protecting a Stack From Being Deleted in the CloudFormation User Guide.
- Returns:
- Whether termination protection is enabled for the stack.
For nested stacks, termination protection is set on the root stack and can't be changed directly on the nested stack. For more information, see Protecting a Stack From Being Deleted in the CloudFormation User Guide.
-
parentId
For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack.
For more information, see Working with Nested Stacks in the CloudFormation User Guide.
- Returns:
- For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of
this stack. For the first level of nested stacks, the root stack is also the parent stack.
For more information, see Working with Nested Stacks in the CloudFormation User Guide.
-
rootId
For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which the nested stack ultimately belongs.
For more information, see Working with Nested Stacks in the CloudFormation User Guide.
- Returns:
- For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to
which the nested stack ultimately belongs.
For more information, see Working with Nested Stacks in the CloudFormation User Guide.
-
driftInformation
Information about whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
- Returns:
- Information about whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
-
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
-
detailedStatus
The detailed status of the resource or stack. If
CONFIGURATION_COMPLETE
is present, the resource or resource configuration phase has completed and the stabilization of the resources is in progress. The stack setsCONFIGURATION_COMPLETE
when all of the resources in the stack have reached that event. For more information, see CloudFormation stack deployment in the CloudFormation User Guide.If the service returns an enum value that is not available in the current SDK version,
detailedStatus
will returnDetailedStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdetailedStatusAsString()
.- Returns:
- The detailed status of the resource or stack. If
CONFIGURATION_COMPLETE
is present, the resource or resource configuration phase has completed and the stabilization of the resources is in progress. The stack setsCONFIGURATION_COMPLETE
when all of the resources in the stack have reached that event. For more information, see CloudFormation stack deployment in the CloudFormation User Guide. - See Also:
-
detailedStatusAsString
The detailed status of the resource or stack. If
CONFIGURATION_COMPLETE
is present, the resource or resource configuration phase has completed and the stabilization of the resources is in progress. The stack setsCONFIGURATION_COMPLETE
when all of the resources in the stack have reached that event. For more information, see CloudFormation stack deployment in the CloudFormation User Guide.If the service returns an enum value that is not available in the current SDK version,
detailedStatus
will returnDetailedStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdetailedStatusAsString()
.- Returns:
- The detailed status of the resource or stack. If
CONFIGURATION_COMPLETE
is present, the resource or resource configuration phase has completed and the stabilization of the resources is in progress. The stack setsCONFIGURATION_COMPLETE
when all of the resources in the stack have reached that event. For more information, see CloudFormation stack deployment in the CloudFormation User Guide. - See Also:
-
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<Stack.Builder,
Stack> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
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
-
sdkFields
-