Serializable
, SdkPojo
, ToCopyableBuilder<Stack.Builder,Stack>
The Stack data type.
See Also:Nested Class Summary
Nested Classes
static interface
Method Summary
All MethodsStatic MethodsInstance MethodsConcrete Methods
The capabilities allowed in the stack.
The capabilities allowed in the stack.
The unique ID of the change set.
The time at which the stack was created.
The time the stack was deleted.
A user-defined description associated with the stack.
The detailed status of the resource or stack.
The detailed status of the resource or stack.
Boolean to enable or disable rollback on stack creation failures:
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.
Whether termination protection is enabled for the stack.
final boolean
final boolean
Indicates whether some other object is "equal to" this one by SDK fields.
final boolean
For responses, this returns true if the service returned a value for the Capabilities property.
final int
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
For responses, this returns true if the service returned a value for the Tags property.
The time the stack was last updated.
Amazon SNS topic Amazon Resource Names (ARNs) to which stack related events are published.
A list of output structures.
A list of
Parameter
structures.For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack.
When set to
true
, newly created resources are deleted when the operation rolls back.The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that's associated with the stack.
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
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.
Unique identifier of the stack.
The name associated with the stack.
Current status of the stack.
Current status of the stack.
Success/failure message associated with the stack status.
A list of
Tag
s that specify information about the stack.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.
Returns a string representation of this object.
Method Details
stackId
public final String stackId()Unique identifier of the stack.
Returns: Unique identifier of the stack.stackName
public final String stackName()The name associated with the stack.
Returns: The name associated with the stack.changeSetId
public final String changeSetId()The unique ID of the change set.
Returns: The unique ID of the change set.description
public final String 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 the
isEmpty()
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
Returns: A list ofhasParameters()
method.Parameter
structures.creationTime
public final Instant creationTime()The time at which the stack was created.
Returns: The time at which the stack was created.deletionTime
public final Instant deletionTime()The time the stack was deleted.
Returns: The time the stack was deleted.lastUpdatedTime
public final Instant 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
Returns: Current status of the stack. See Also:stackStatusAsString
public final String stackStatusAsString() Returns: Current status of the stack. See Also:stackStatusReason
public final String stackStatusReason()Success/failure message associated with the stack status.
Returns: Success/failure message associated with the stack status.disableRollback
public final Boolean disableRollback()Boolean to enable or disable rollback on stack creation failures:
true
: disable rollback.false
: enable rollback.
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 the
isEmpty()
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
Returns: Amazon SNS topic Amazon Resource Names (ARNs) to which stack related events are published.hasNotificationARNs()
method.timeoutInMinutes
public final Integer 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
Returns: The capabilities allowed in the stack.hasCapabilities()
method.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 the
isEmpty()
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
public final List<String> 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
Returns: The capabilities allowed in the stack.hasCapabilities()
method.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 the
isEmpty()
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
Returns: A list of output structures.hasOutputs()
method.roleARN
public final String 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 the
isEmpty()
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
Returns: A list ofhasTags()
method.Tag
s that specify information about the stack.enableTerminationProtection
public final Boolean 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
public final String 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
public 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.
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
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
public final Boolean 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:
Returns: When set tofalse
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,
Returns: The detailed status of the resource or stack. IfdetailedStatus
will returnDetailedStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdetailedStatusAsString()
.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
public final String 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,
Returns: The detailed status of the resource or stack. IfdetailedStatus
will returnDetailedStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdetailedStatusAsString()
.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
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 Tbuilder
serializableBuilderClass
hashCode
public final int hashCode()
Overrides:hashCode
in classObject
equals
public final boolean equals(Object obj) Overrides:equals
in classObject
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj) 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
Specified by:SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.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
public final String 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.
Overrides:toString
in classObject
getValueForField
sdkFields
Specified by:sdkFields
in interfaceSdkPojo
Returns: List ofSdkField
in this POJO. May be empty list but should never be null.
ncG1vNJzZmirlKB7ornAs6anmaeoe6S7zGihmq6RZK6xtY6lmK2do6l8tLvFra6aqpVkrq6t2ailaJmnqMClt46snKuumZiytHvCpaaunJakv66t06Kmp2edpLGmuI6Mq5qbm2O1tbnL