Class StackSummary
- java.lang.Object
-
- software.amazon.awssdk.services.cloudformation.model.StackSummary
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<StackSummary.Builder,StackSummary>
@Generated("software.amazon.awssdk:codegen") public final class StackSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<StackSummary.Builder,StackSummary>
The StackSummary Data Type
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
StackSummary.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static StackSummary.Builder
builder()
Instant
creationTime()
The time the stack was created.Instant
deletionTime()
The time the stack was deleted.StackDriftInformationSummary
driftInformation()
Summarizes 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.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
Instant
lastUpdatedTime()
The time the stack was last updated.String
parentId()
For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack.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.Map<String,SdkField<?>>
sdkFieldNameToField()
List<SdkField<?>>
sdkFields()
static Class<? extends StackSummary.Builder>
serializableBuilderClass()
String
stackId()
Unique stack identifier.String
stackName()
The name associated with the stack.StackStatus
stackStatus()
The current status of the stack.String
stackStatusAsString()
The current status of the stack.String
stackStatusReason()
Success/Failure message associated with the stack status.String
templateDescription()
The template description of the template used to create the stack.StackSummary.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
stackId
public final String stackId()
Unique stack identifier.
- Returns:
- Unique stack identifier.
-
stackName
public final String stackName()
The name associated with the stack.
- Returns:
- The name associated with the stack.
-
templateDescription
public final String templateDescription()
The template description of the template used to create the stack.
- Returns:
- The template description of the template used to create the stack.
-
creationTime
public final Instant creationTime()
The time the stack was created.
- Returns:
- The time the stack was created.
-
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.
-
deletionTime
public final Instant deletionTime()
The time the stack was deleted.
- Returns:
- The time the stack was deleted.
-
stackStatus
public final StackStatus stackStatus()
The 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:
- The current status of the stack.
- See Also:
StackStatus
-
stackStatusAsString
public final String stackStatusAsString()
The 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:
- The current status of the stack.
- See Also:
StackStatus
-
stackStatusReason
public final String stackStatusReason()
Success/Failure message associated with the stack status.
- Returns:
- Success/Failure message associated with the stack status.
-
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 Embed stacks within other stacks using 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 Embed stacks within other stacks using 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 Embed stacks within other stacks using 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 Embed stacks within other stacks using nested stacks in the CloudFormation User Guide.
-
driftInformation
public final StackDriftInformationSummary driftInformation()
Summarizes 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 Detect unmanaged configuration changes to stacks and resources with drift detection.
- Returns:
- Summarizes 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 Detect unmanaged configuration changes to stacks and resources with drift detection.
-
toBuilder
public StackSummary.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<StackSummary.Builder,StackSummary>
-
builder
public static StackSummary.Builder builder()
-
serializableBuilderClass
public static Class<? extends StackSummary.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
-
-