Package software.amazon.awssdk.services.lightsail.model

Class DnsRecordCreationState

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

Describes the creation state of the canonical name (CNAME) records that are automatically added by Amazon Lightsail to the DNS of a domain to validate domain ownership for an SSL/TLS certificate.

When you create an SSL/TLS certificate for a Lightsail resource, you must add a set of CNAME records to the DNS of the domains for the certificate to validate that you own the domains. Lightsail can automatically add the CNAME records to the DNS of the domain if the DNS zone for the domain exists within your Lightsail account. If automatic record addition fails, or if you manage the DNS of your domain using a third-party service, then you must manually add the CNAME records to the DNS of your domain. For more information, see Verify an SSL/TLS certificate in Amazon Lightsail in the Amazon Lightsail Developer Guide.

See Also:

  • Method Details

    • code

      public final DnsRecordCreationStateCode code()

      The status code for the automated DNS record creation.

      Following are the possible values:

      • SUCCEEDED - The validation records were successfully added to the domain.

      • STARTED - The automatic DNS record creation has started.

      • FAILED - The validation records failed to be added to the domain.

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

      Returns:
      The status code for the automated DNS record creation.

      Following are the possible values:

      • SUCCEEDED - The validation records were successfully added to the domain.

      • STARTED - The automatic DNS record creation has started.

      • FAILED - The validation records failed to be added to the domain.

      See Also:

    • codeAsString

      public final String codeAsString()

      The status code for the automated DNS record creation.

      Following are the possible values:

      • SUCCEEDED - The validation records were successfully added to the domain.

      • STARTED - The automatic DNS record creation has started.

      • FAILED - The validation records failed to be added to the domain.

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

      Returns:
      The status code for the automated DNS record creation.

      Following are the possible values:

      • SUCCEEDED - The validation records were successfully added to the domain.

      • STARTED - The automatic DNS record creation has started.

      • FAILED - The validation records failed to be added to the domain.

      See Also:

    • message

      public final String message()

      The message that describes the reason for the status code.

      Returns:
      The message that describes the reason for the status code.

    • toBuilder

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

    • builder

      public static DnsRecordCreationState.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DnsRecordCreationState.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.