Class TemplateSummary
- java.lang.Object
-
- software.amazon.awssdk.services.cloudformation.model.TemplateSummary
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<TemplateSummary.Builder,TemplateSummary>
@Generated("software.amazon.awssdk:codegen") public final class TemplateSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<TemplateSummary.Builder,TemplateSummary>
The summary of a generated template.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
TemplateSummary.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static TemplateSummary.Builder
builder()
Instant
creationTime()
The time the generated template was created.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
String
generatedTemplateId()
The Amazon Resource Name (ARN) of the generated template.String
generatedTemplateName()
The name of the generated template.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
Instant
lastUpdatedTime()
The time the generated template was last updated.Integer
numberOfResources()
The number of resources in the generated template.List<SdkField<?>>
sdkFields()
static Class<? extends TemplateSummary.Builder>
serializableBuilderClass()
GeneratedTemplateStatus
status()
The status of the template generation.String
statusAsString()
The status of the template generation.String
statusReason()
The reason for the current template generation status.TemplateSummary.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
-
generatedTemplateId
public final String 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
public final String generatedTemplateName()
The name of the generated template.
- Returns:
- The name of the generated template.
-
status
public final GeneratedTemplateStatus 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:
GeneratedTemplateStatus
-
-
statusAsString
public final String 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:
GeneratedTemplateStatus
-
-
statusReason
public final String 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
public final Instant creationTime()
The time the generated template was created.
- Returns:
- The time the generated template was created.
-
lastUpdatedTime
public final Instant lastUpdatedTime()
The time the generated template was last updated.
- Returns:
- The time the generated template was last updated.
-
numberOfResources
public final Integer 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
public TemplateSummary.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<TemplateSummary.Builder,TemplateSummary>
-
builder
public static TemplateSummary.Builder builder()
-
serializableBuilderClass
public static Class<? extends TemplateSummary.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.
-
-