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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceIdentityDkimAttributes.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static IdentityDkimAttributes.Builderbuilder()BooleandkimEnabled()Is true if DKIM signing is enabled for email sent from the identity.List<String>dkimTokens()A set of character strings that represent the domain's identity.VerificationStatusdkimVerificationStatus()Describes whether Amazon SES has successfully verified the DKIM DNS records (tokens) published in the domain name's DNS.StringdkimVerificationStatusAsString()Describes whether Amazon SES has successfully verified the DKIM DNS records (tokens) published in the domain name's DNS.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasDkimTokens()For responses, this returns true if the service returned a value for the DkimTokens property.inthashCode()Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends IdentityDkimAttributes.Builder>serializableBuilderClass()IdentityDkimAttributes.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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,
dkimVerificationStatuswill returnVerificationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdkimVerificationStatusAsString().- 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:
VerificationStatus
-
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,
dkimVerificationStatuswill returnVerificationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdkimVerificationStatusAsString().- 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:
VerificationStatus
-
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 theisEmpty()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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<IdentityDkimAttributes.Builder,IdentityDkimAttributes>
-
builder
public static IdentityDkimAttributes.Builder builder()
-
serializableBuilderClass
public static Class<? extends IdentityDkimAttributes.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-