Class IdentityDkimAttributes

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

Represents the DKIM attributes of a verified email address or a domain.

See Also:

  • Method Details

    • dkimEnabled

      public final Boolean dkimEnabled()

      Is true if DKIM signing is enabled for email sent from the identity. It's false otherwise. The default value is true.

      Returns:
      Is true if DKIM signing is enabled for email sent from the identity. It's false otherwise. The default value is true.

    • dkimVerificationStatus

      public final VerificationStatus dkimVerificationStatus()

      Describes whether Amazon SES has successfully verified the DKIM DNS records (tokens) published in the domain name's DNS. (This only applies to domain identities, not email address identities.)

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

      Returns:
      Describes whether Amazon SES has successfully verified the DKIM DNS records (tokens) published in the domain name's DNS. (This only applies to domain identities, not email address identities.)
      See Also:

    • dkimVerificationStatusAsString

      public final String dkimVerificationStatusAsString()

      Describes whether Amazon SES has successfully verified the DKIM DNS records (tokens) published in the domain name's DNS. (This only applies to domain identities, not email address identities.)

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

      Returns:
      Describes whether Amazon SES has successfully verified the DKIM DNS records (tokens) published in the domain name's DNS. (This only applies to domain identities, not email address identities.)
      See Also:

    • hasDkimTokens

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

    • dkimTokens

      public final List<String> dkimTokens()

      A set of character strings that represent the domain's identity. Using these tokens, you need to create DNS CNAME records that point to DKIM public keys that are hosted by Amazon SES. Amazon Web Services eventually detects that you've updated your DNS records. This detection process might take up to 72 hours. After successful detection, Amazon SES is able to DKIM-sign email originating from that domain. (This only applies to domain identities, not email address identities.)

      For more information about creating DNS records using DKIM tokens, see the Amazon SES Developer Guide.

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

      Returns:
      A set of character strings that represent the domain's identity. Using these tokens, you need to create DNS CNAME records that point to DKIM public keys that are hosted by Amazon SES. Amazon Web Services eventually detects that you've updated your DNS records. This detection process might take up to 72 hours. After successful detection, Amazon SES is able to DKIM-sign email originating from that domain. (This only applies to domain identities, not email address identities.)

      For more information about creating DNS records using DKIM tokens, see the Amazon SES Developer Guide.

    • toBuilder

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

    • builder

      public static IdentityDkimAttributes.Builder builder()

    • serializableBuilderClass

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