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

Class TemplateConfiguration

java.lang.Object
software.amazon.awssdk.services.cloudformation.model.TemplateConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<TemplateConfiguration.Builder,TemplateConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class TemplateConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<TemplateConfiguration.Builder,TemplateConfiguration>

The configuration details of a generated template.

See Also:

  • Method Details

    • deletionPolicy

      public final GeneratedTemplateDeletionPolicy deletionPolicy()

      The DeletionPolicy assigned to resources in the generated template. Supported values are:

      • DELETE - delete all resources when the stack is deleted.

      • RETAIN - retain all resources when the stack is deleted.

      For more information, see DeletionPolicy attribute in the CloudFormation User Guide.

      If the service returns an enum value that is not available in the current SDK version, deletionPolicy will return GeneratedTemplateDeletionPolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deletionPolicyAsString().

      Returns:
      The DeletionPolicy assigned to resources in the generated template. Supported values are:

      • DELETE - delete all resources when the stack is deleted.

      • RETAIN - retain all resources when the stack is deleted.

      For more information, see DeletionPolicy attribute in the CloudFormation User Guide.

      See Also:

    • deletionPolicyAsString

      public final String deletionPolicyAsString()

      The DeletionPolicy assigned to resources in the generated template. Supported values are:

      • DELETE - delete all resources when the stack is deleted.

      • RETAIN - retain all resources when the stack is deleted.

      For more information, see DeletionPolicy attribute in the CloudFormation User Guide.

      If the service returns an enum value that is not available in the current SDK version, deletionPolicy will return GeneratedTemplateDeletionPolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deletionPolicyAsString().

      Returns:
      The DeletionPolicy assigned to resources in the generated template. Supported values are:

      • DELETE - delete all resources when the stack is deleted.

      • RETAIN - retain all resources when the stack is deleted.

      For more information, see DeletionPolicy attribute in the CloudFormation User Guide.

      See Also:

    • updateReplacePolicy

      public final GeneratedTemplateUpdateReplacePolicy updateReplacePolicy()

      The UpdateReplacePolicy assigned to resources in the generated template. Supported values are:

      • DELETE - delete all resources when the resource is replaced during an update operation.

      • RETAIN - retain all resources when the resource is replaced during an update operation.

      For more information, see UpdateReplacePolicy attribute in the CloudFormation User Guide.

      If the service returns an enum value that is not available in the current SDK version, updateReplacePolicy will return GeneratedTemplateUpdateReplacePolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from updateReplacePolicyAsString().

      Returns:
      The UpdateReplacePolicy assigned to resources in the generated template. Supported values are:

      • DELETE - delete all resources when the resource is replaced during an update operation.

      • RETAIN - retain all resources when the resource is replaced during an update operation.

      For more information, see UpdateReplacePolicy attribute in the CloudFormation User Guide.

      See Also:

    • updateReplacePolicyAsString

      public final String updateReplacePolicyAsString()

      The UpdateReplacePolicy assigned to resources in the generated template. Supported values are:

      • DELETE - delete all resources when the resource is replaced during an update operation.

      • RETAIN - retain all resources when the resource is replaced during an update operation.

      For more information, see UpdateReplacePolicy attribute in the CloudFormation User Guide.

      If the service returns an enum value that is not available in the current SDK version, updateReplacePolicy will return GeneratedTemplateUpdateReplacePolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from updateReplacePolicyAsString().

      Returns:
      The UpdateReplacePolicy assigned to resources in the generated template. Supported values are:

      • DELETE - delete all resources when the resource is replaced during an update operation.

      • RETAIN - retain all resources when the resource is replaced during an update operation.

      For more information, see UpdateReplacePolicy attribute in the CloudFormation User Guide.

      See Also:

    • toBuilder

      public TemplateConfiguration.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<TemplateConfiguration.Builder,TemplateConfiguration>
      Returns:
      a builder for type T

    • builder

      public static TemplateConfiguration.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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

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