software.amazon.awssdk.services.sesv2.model

Interface DkimAttributes.Builder

All Superinterfaces:

Buildable, CopyableBuilder<DkimAttributes.Builder,DkimAttributes>, SdkBuilder<DkimAttributes.Builder,DkimAttributes>, SdkPojo

Enclosing class:

DkimAttributes

public static interface DkimAttributes.Builder
extends SdkPojo, CopyableBuilder<DkimAttributes.Builder,DkimAttributes>

Method Summary

Modifier and Type	Method and Description
DkimAttributes.Builder	currentSigningKeyLength(DkimSigningKeyLength currentSigningKeyLength) [Easy DKIM] The key length of the DKIM key pair in use.
DkimAttributes.Builder	currentSigningKeyLength(String currentSigningKeyLength) [Easy DKIM] The key length of the DKIM key pair in use.
DkimAttributes.Builder	lastKeyGenerationTimestamp(Instant lastKeyGenerationTimestamp) [Easy DKIM] The last time a key pair was generated for this identity.
DkimAttributes.Builder	nextSigningKeyLength(DkimSigningKeyLength nextSigningKeyLength) [Easy DKIM] The key length of the future DKIM key pair to be generated.
DkimAttributes.Builder	nextSigningKeyLength(String nextSigningKeyLength) [Easy DKIM] The key length of the future DKIM key pair to be generated.
DkimAttributes.Builder	signingAttributesOrigin(DkimSigningAttributesOrigin signingAttributesOrigin) A string that indicates how DKIM was configured for the identity.
DkimAttributes.Builder	signingAttributesOrigin(String signingAttributesOrigin) A string that indicates how DKIM was configured for the identity.
DkimAttributes.Builder	signingEnabled(Boolean signingEnabled) If the value is true, then the messages that you send from the identity are signed using DKIM.
DkimAttributes.Builder	status(DkimStatus status) Describes whether or not Amazon SES has successfully located the DKIM records in the DNS records for the domain.
DkimAttributes.Builder	status(String status) Describes whether or not Amazon SES has successfully located the DKIM records in the DNS records for the domain.
DkimAttributes.Builder	tokens(Collection<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.
DkimAttributes.Builder	tokens(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.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

signingEnabled

DkimAttributes.Builder signingEnabled(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

status

DkimAttributes.Builder status(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DkimStatus, DkimStatus

status

DkimAttributes.Builder status(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DkimStatus, DkimStatus

tokens

DkimAttributes.Builder tokens(Collection<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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

tokens

DkimAttributes.Builder tokens(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

signingAttributesOrigin

DkimAttributes.Builder signingAttributesOrigin(String signingAttributesOrigin)

A string that indicates how DKIM was configured for the identity. These are the 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).

Parameters:

signingAttributesOrigin - A string that indicates how DKIM was configured for the identity. These are the 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).

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DkimSigningAttributesOrigin, DkimSigningAttributesOrigin

signingAttributesOrigin

DkimAttributes.Builder signingAttributesOrigin(DkimSigningAttributesOrigin signingAttributesOrigin)

A string that indicates how DKIM was configured for the identity. These are the 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).

Parameters:

signingAttributesOrigin - A string that indicates how DKIM was configured for the identity. These are the 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).

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DkimSigningAttributesOrigin, DkimSigningAttributesOrigin

nextSigningKeyLength

DkimAttributes.Builder nextSigningKeyLength(String nextSigningKeyLength)

[Easy DKIM] The key length of the future DKIM key pair to be generated. This can be changed at most once per day.

Parameters:

nextSigningKeyLength - [Easy DKIM] The key length of the future DKIM key pair to be generated. This can be changed at most once per day.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DkimSigningKeyLength, DkimSigningKeyLength

nextSigningKeyLength

DkimAttributes.Builder nextSigningKeyLength(DkimSigningKeyLength nextSigningKeyLength)

[Easy DKIM] The key length of the future DKIM key pair to be generated. This can be changed at most once per day.

Parameters:

nextSigningKeyLength - [Easy DKIM] The key length of the future DKIM key pair to be generated. This can be changed at most once per day.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DkimSigningKeyLength, DkimSigningKeyLength

currentSigningKeyLength

DkimAttributes.Builder currentSigningKeyLength(String currentSigningKeyLength)

[Easy DKIM] The key length of the DKIM key pair in use.

Parameters:

currentSigningKeyLength - [Easy DKIM] The key length of the DKIM key pair in use.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DkimSigningKeyLength, DkimSigningKeyLength

currentSigningKeyLength

DkimAttributes.Builder currentSigningKeyLength(DkimSigningKeyLength currentSigningKeyLength)

[Easy DKIM] The key length of the DKIM key pair in use.

Parameters:

currentSigningKeyLength - [Easy DKIM] The key length of the DKIM key pair in use.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DkimSigningKeyLength, DkimSigningKeyLength

lastKeyGenerationTimestamp

DkimAttributes.Builder lastKeyGenerationTimestamp(Instant lastKeyGenerationTimestamp)

[Easy DKIM] The last time a key pair was generated for this identity.

Parameters:

lastKeyGenerationTimestamp - [Easy DKIM] The last time a key pair was generated for this identity.

Returns:

Returns a reference to this object so that method calls can be chained together.