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
StackSummaryData Type- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceStackSummary.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static StackSummary.Builderbuilder()InstantcreationTime()The time the stack was created.InstantdeletionTime()The time the stack was deleted.StackDriftInformationSummarydriftInformation()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.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasLastOperations()For responses, this returns true if the service returned a value for the LastOperations property.List<OperationEntry>lastOperations()Information about the most recent operations performed on this stack.InstantlastUpdatedTime()The time the stack was last updated.StringparentId()For nested stacks, the stack ID of the direct parent of this stack.StringrootId()For nested stacks, 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()StringstackId()Unique stack identifier.StringstackName()The name associated with the stack.StackStatusstackStatus()The current status of the stack.StringstackStatusAsString()The current status of the stack.StringstackStatusReason()Success/Failure message associated with the stack status.StringtemplateDescription()The template description of the template used to create the stack.StackSummary.BuildertoBuilder()StringtoString()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,
stackStatuswill 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,
stackStatuswill 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, 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 Nested stacks in the CloudFormation User Guide.
- Returns:
- For nested stacks, 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 Nested stacks in the CloudFormation User Guide.
-
rootId
public final String rootId()
For nested stacks, the stack ID of the top-level stack to which the nested stack ultimately belongs.
For more information, see Nested stacks in the CloudFormation User Guide.
- Returns:
- For nested stacks, the stack ID of the top-level stack to which the nested stack ultimately belongs.
For more information, see 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.
-
hasLastOperations
public final boolean hasLastOperations()
For responses, this returns true if the service returned a value for the LastOperations 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.
-
lastOperations
public final List<OperationEntry> lastOperations()
Information about the most recent operations performed on this 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
hasLastOperations()method.- Returns:
- Information about the most recent operations performed on this stack.
-
toBuilder
public StackSummary.Builder toBuilder()
- Specified by:
toBuilderin 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:
equalsBySdkFieldsin 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:
sdkFieldNameToFieldin interfaceSdkPojo
-
-