Class TemplateSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<TemplateSummary.Builder,
TemplateSummary>
The summary of a generated template.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic TemplateSummary.Builder
builder()
final Instant
The time the generated template was created.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The Amazon Resource Name (ARN) of the generated template.final String
The name of the generated template.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Instant
The time the generated template was last updated.final Integer
The number of resources in the generated template.static Class
<? extends TemplateSummary.Builder> final GeneratedTemplateStatus
status()
The status of the template generation.final String
The status of the template generation.final String
The reason for the current template generation status.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
-
generatedTemplateId
The Amazon Resource Name (ARN) of the generated template. The format is
arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}
. For example,arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc
.- Returns:
- The Amazon Resource Name (ARN) of the generated template. The format is
arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}
. For example,arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc
.
-
generatedTemplateName
The name of the generated template.
- Returns:
- The name of the generated template.
-
status
The status of the template generation. Supported values are:
-
CreatePending
- the creation of the template is pending. -
CreateInProgress
- the creation of the template is in progress. -
DeletePending
- the deletion of the template is pending. -
DeleteInProgress
- the deletion of the template is in progress. -
UpdatePending
- the update of the template is pending. -
UpdateInProgress
- the update of the template is in progress. -
Failed
- the template operation failed. -
Complete
- the template operation is complete.
If the service returns an enum value that is not available in the current SDK version,
status
will returnGeneratedTemplateStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the template generation. Supported values are:
-
CreatePending
- the creation of the template is pending. -
CreateInProgress
- the creation of the template is in progress. -
DeletePending
- the deletion of the template is pending. -
DeleteInProgress
- the deletion of the template is in progress. -
UpdatePending
- the update of the template is pending. -
UpdateInProgress
- the update of the template is in progress. -
Failed
- the template operation failed. -
Complete
- the template operation is complete.
-
- See Also:
-
-
statusAsString
The status of the template generation. Supported values are:
-
CreatePending
- the creation of the template is pending. -
CreateInProgress
- the creation of the template is in progress. -
DeletePending
- the deletion of the template is pending. -
DeleteInProgress
- the deletion of the template is in progress. -
UpdatePending
- the update of the template is pending. -
UpdateInProgress
- the update of the template is in progress. -
Failed
- the template operation failed. -
Complete
- the template operation is complete.
If the service returns an enum value that is not available in the current SDK version,
status
will returnGeneratedTemplateStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the template generation. Supported values are:
-
CreatePending
- the creation of the template is pending. -
CreateInProgress
- the creation of the template is in progress. -
DeletePending
- the deletion of the template is pending. -
DeleteInProgress
- the deletion of the template is in progress. -
UpdatePending
- the update of the template is pending. -
UpdateInProgress
- the update of the template is in progress. -
Failed
- the template operation failed. -
Complete
- the template operation is complete.
-
- See Also:
-
-
statusReason
The reason for the current template generation status. This will provide more details if a failure happened.
- Returns:
- The reason for the current template generation status. This will provide more details if a failure happened.
-
creationTime
The time the generated template was created.
- Returns:
- The time the generated template was created.
-
lastUpdatedTime
The time the generated template was last updated.
- Returns:
- The time the generated template was last updated.
-
numberOfResources
The number of resources in the generated template. This is a total of resources in pending, in-progress, completed, and failed states.
- Returns:
- The number of resources in the generated template. This is a total of resources in pending, in-progress, completed, and failed states.
-
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<TemplateSummary.Builder,
TemplateSummary> - 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
-