DkimAttributes (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.sesv2.model.DkimAttributes

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DkimAttributes.Builder,DkimAttributes>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class DkimAttributes
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DkimAttributes.Builder,DkimAttributes>
```
An object that contains information about the DKIM authentication status for an email identity.

Amazon SES determines the authentication status by searching for specific records in the DNS configuration for the domain. If you used Easy DKIM to set up DKIM authentication, Amazon SES tries to find three unique CNAME records in the DNS configuration for your domain. If you provided a public key to perform DKIM authentication, Amazon SES tries to find a TXT record that uses the selector that you specified. The value of the TXT record must be a public key that's paired with the private key that you specified in the process of creating the identity

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DkimAttributes.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DkimAttributes.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DkimAttributes.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTokens()` Returns true if the Tokens property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DkimAttributes.Builder>`	`serializableBuilderClass()`
`DkimSigningAttributesOrigin`	`signingAttributesOrigin()` A string that indicates how DKIM was configured for the identity.
`String`	`signingAttributesOriginAsString()` A string that indicates how DKIM was configured for the identity.
`Boolean`	`signingEnabled()` If the value is `true`, then the messages that you send from the identity are signed using DKIM.
`DkimStatus`	`status()` Describes whether or not Amazon SES has successfully located the DKIM records in the DNS records for the domain.
`String`	`statusAsString()` Describes whether or not Amazon SES has successfully located the DKIM records in the DNS records for the domain.
`DkimAttributes.Builder`	`toBuilder()`
`List<String>`	`tokens()` If you used Easy DKIM to configure DKIM authentication for the domain, then this object contains a set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain.
`String`	`toString()` 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
  - signingEnabled
```
public final Boolean signingEnabled()
```
    If the value is true, then the messages that you send from the identity are signed using DKIM. If the value is false, then the messages that you send from the identity aren't DKIM-signed.
    
    Returns:
    
    If the value is true, then the messages that you send from the identity are signed using DKIM. If the value is false, then the messages that you send from the identity aren't DKIM-signed.
  - status
```
public final DkimStatus status()
```
    Describes whether or not Amazon SES has successfully located the DKIM records in the DNS records for the domain. The status can be one of the following:
    - PENDING – The verification process was initiated, but Amazon SES hasn't yet detected the DKIM records in the DNS configuration for the domain.
    - SUCCESS – The verification process completed successfully.
    - FAILED – The verification process failed. This typically occurs when Amazon SES fails to find the DKIM records in the DNS configuration of the domain.
    - TEMPORARY_FAILURE – A temporary issue is preventing Amazon SES from determining the DKIM authentication status of the domain.
    - NOT_STARTED – The DKIM verification process hasn't been initiated for the domain.
    If the service returns an enum value that is not available in the current SDK version, status will return DkimStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    Returns:
    Describes whether or not Amazon SES has successfully located the DKIM records in the DNS records for the domain. The status can be one of the following:
    
    PENDING – The verification process was initiated, but Amazon SES hasn't yet detected the DKIM records in the DNS configuration for the domain.
    
    SUCCESS – The verification process completed successfully.
    
    FAILED – The verification process failed. This typically occurs when Amazon SES fails to find the DKIM records in the DNS configuration of the domain.
    
    TEMPORARY_FAILURE – A temporary issue is preventing Amazon SES from determining the DKIM authentication status of the domain.
    
    NOT_STARTED – The DKIM verification process hasn't been initiated for the domain.
    See Also:
    
    DkimStatus
  - statusAsString
```
public final String statusAsString()
```
    Describes whether or not Amazon SES has successfully located the DKIM records in the DNS records for the domain. The status can be one of the following:
    - PENDING – The verification process was initiated, but Amazon SES hasn't yet detected the DKIM records in the DNS configuration for the domain.
    - SUCCESS – The verification process completed successfully.
    - FAILED – The verification process failed. This typically occurs when Amazon SES fails to find the DKIM records in the DNS configuration of the domain.
    - TEMPORARY_FAILURE – A temporary issue is preventing Amazon SES from determining the DKIM authentication status of the domain.
    - NOT_STARTED – The DKIM verification process hasn't been initiated for the domain.
    If the service returns an enum value that is not available in the current SDK version, status will return DkimStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    Returns:
    Describes whether or not Amazon SES has successfully located the DKIM records in the DNS records for the domain. The status can be one of the following:
    
    PENDING – The verification process was initiated, but Amazon SES hasn't yet detected the DKIM records in the DNS configuration for the domain.
    
    SUCCESS – The verification process completed successfully.
    
    FAILED – The verification process failed. This typically occurs when Amazon SES fails to find the DKIM records in the DNS configuration of the domain.
    
    TEMPORARY_FAILURE – A temporary issue is preventing Amazon SES from determining the DKIM authentication status of the domain.
    
    NOT_STARTED – The DKIM verification process hasn't been initiated for the domain.
    See Also:
    
    DkimStatus
  - hasTokens
```
public final boolean hasTokens()
```
    Returns true if the Tokens property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tokens
```
public final List<String> tokens()
```
    If you used Easy DKIM to configure DKIM authentication for the domain, then this object contains a set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon SES detects these records in the DNS configuration for your domain, the DKIM authentication process is complete.
    
    If you configured DKIM authentication for the domain by providing your own public-private key pair, then this object contains the selector for the public key.
    
    Regardless of the DKIM authentication method you use, Amazon SES searches for the appropriate records in the DNS configuration of the domain for up to 72 hours.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTokens() to see if a value was sent in this field.
    
    Returns:
    
    If you used Easy DKIM to configure DKIM authentication for the domain, then this object contains a set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon SES detects these records in the DNS configuration for your domain, the DKIM authentication process is complete.
    
    If you configured DKIM authentication for the domain by providing your own public-private key pair, then this object contains the selector for the public key.
    
    Regardless of the DKIM authentication method you use, Amazon SES searches for the appropriate records in the DNS configuration of the domain for up to 72 hours.
  - signingAttributesOrigin
```
public final DkimSigningAttributesOrigin signingAttributesOrigin()
```
    A string that indicates how DKIM was configured for the identity. There are two possible values:
    - AWS_SES – Indicates that DKIM was configured for the identity by using Easy DKIM.
    - EXTERNAL – Indicates that DKIM was configured for the identity by using Bring Your Own DKIM (BYODKIM).
    If the service returns an enum value that is not available in the current SDK version, signingAttributesOrigin will return DkimSigningAttributesOrigin.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from signingAttributesOriginAsString().
    Returns:
    A string that indicates how DKIM was configured for the identity. There are two possible values:
    
    AWS_SES – Indicates that DKIM was configured for the identity by using Easy DKIM.
    
    EXTERNAL – Indicates that DKIM was configured for the identity by using Bring Your Own DKIM (BYODKIM).
    See Also:
    
    DkimSigningAttributesOrigin
  - signingAttributesOriginAsString
```
public final String signingAttributesOriginAsString()
```
    A string that indicates how DKIM was configured for the identity. There are two possible values:
    - AWS_SES – Indicates that DKIM was configured for the identity by using Easy DKIM.
    - EXTERNAL – Indicates that DKIM was configured for the identity by using Bring Your Own DKIM (BYODKIM).
    If the service returns an enum value that is not available in the current SDK version, signingAttributesOrigin will return DkimSigningAttributesOrigin.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from signingAttributesOriginAsString().
    Returns:
    A string that indicates how DKIM was configured for the identity. There are two possible values:
    
    AWS_SES – Indicates that DKIM was configured for the identity by using Easy DKIM.
    
    EXTERNAL – Indicates that DKIM was configured for the identity by using Bring Your Own DKIM (BYODKIM).
    See Also:
    
    DkimSigningAttributesOrigin
  - toBuilder
```
public DkimAttributes.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DkimAttributes.Builder,DkimAttributes>
  - builder
```
public static DkimAttributes.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DkimAttributes.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class DkimAttributes

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

signingEnabled

status

statusAsString

hasTokens

tokens

signingAttributesOrigin

signingAttributesOriginAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields