Package software.amazon.awssdk.services.cloudformation.model

Class DescribeGeneratedTemplateResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.cloudformation.model.CloudFormationResponse
software.amazon.awssdk.services.cloudformation.model.DescribeGeneratedTemplateResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeGeneratedTemplateResponse.Builder,DescribeGeneratedTemplateResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeGeneratedTemplateResponse extends CloudFormationResponse implements ToCopyableBuilder<DescribeGeneratedTemplateResponse.Builder,DescribeGeneratedTemplateResponse>

  • Method Details

    • 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.

    • hasResources

      public final boolean hasResources()
      For responses, this returns true if the service returned a value for the Resources 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.

    • resources

      public final List<ResourceDetail> resources()

      A list of objects describing the details of the resources in the template generation.

      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 hasResources() method.

      Returns:
      A list of objects describing the details of the resources in the template generation.

    • 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 return GeneratedTemplateStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      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

      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 return GeneratedTemplateStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      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

      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.

    • progress

      public final TemplateProgress progress()

      An object describing the progress of the template generation.

      Returns:
      An object describing the progress of the template generation.

    • stackId

      public final String stackId()

      The stack ARN of the base stack if a base stack was provided when generating the template.

      Returns:
      The stack ARN of the base stack if a base stack was provided when generating the template.

    • templateConfiguration

      public final TemplateConfiguration templateConfiguration()

      The configuration details of the generated template, including the DeletionPolicy and UpdateReplacePolicy.

      Returns:
      The configuration details of the generated template, including the DeletionPolicy and UpdateReplacePolicy.

    • totalWarnings

      public final Integer totalWarnings()

      The number of warnings generated for this template. The warnings are found in the details of each of the resources in the template.

      Returns:
      The number of warnings generated for this template. The warnings are found in the details of each of the resources in the template.

    • toBuilder

      public DescribeGeneratedTemplateResponse.Builder 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 interface ToCopyableBuilder<DescribeGeneratedTemplateResponse.Builder,DescribeGeneratedTemplateResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeGeneratedTemplateResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeGeneratedTemplateResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      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 class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.