Class TemplateSummary

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

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)