Skip to content

/AWS1/CL_SE2DKIMSIGNINGATTRS

An object that contains configuration for Bring Your Own DKIM (BYODKIM), or, for Easy DKIM

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_domainsigningselector TYPE /AWS1/SE2SELECTOR /AWS1/SE2SELECTOR

[Bring Your Own DKIM] A string that's used to identify a public key in the DNS configuration for a domain.

iv_domainsigningprivatekey TYPE /AWS1/SE2PRIVATEKEY /AWS1/SE2PRIVATEKEY

[Bring Your Own DKIM] A private key that's used to generate a DKIM signature.

The private key must use 1024 or 2048-bit RSA encryption, and must be encoded using base64 encoding.

iv_nextsigningkeylength TYPE /AWS1/SE2DKIMSIGNINGKEYLENGTH /AWS1/SE2DKIMSIGNINGKEYLENGTH

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

iv_domainsigningattrsorigin TYPE /AWS1/SE2DKIMSIGNINGATTRSORI00 /AWS1/SE2DKIMSIGNINGATTRSORI00

The attribute to use for configuring DKIM for the identity depends on the operation:

  1. For PutEmailIdentityDkimSigningAttributes:

  2. For CreateEmailIdentity when replicating a parent identity's DKIM configuration:

    • Allowed values: All values except AWS_SES and EXTERNAL

  • AWS_SES – Configure DKIM for the identity by using Easy DKIM.

  • EXTERNAL – Configure DKIM for the identity by using Bring Your Own DKIM (BYODKIM).

  • AWS_SES_ – Configure DKIM for the identity by replicating the signing attributes of a parent identity in another Amazon Web Services Region, using Deterministic Easy-DKIM (DEED). Replace with the Amazon Web Services Region of the parent identity, in uppercase with each hyphen replaced by an underscore. You can specify any Amazon Web Services Region in which Amazon SES supports DEED. For example, to replicate from a parent identity in us-east-1, specify AWS_SES_US_EAST_1.

    The parent identity must already exist in the specified Amazon Web Services Region and have Easy DKIM configured.

Queryable Attributes

DomainSigningSelector

[Bring Your Own DKIM] A string that's used to identify a public key in the DNS configuration for a domain.

Accessible with the following methods

Method Description
GET_DOMAINSIGNINGSELECTOR() Getter for DOMAINSIGNINGSELECTOR, with configurable default
ASK_DOMAINSIGNINGSELECTOR() Getter for DOMAINSIGNINGSELECTOR w/ exceptions if field has
HAS_DOMAINSIGNINGSELECTOR() Determine if DOMAINSIGNINGSELECTOR has a value

DomainSigningPrivateKey

[Bring Your Own DKIM] A private key that's used to generate a DKIM signature.

The private key must use 1024 or 2048-bit RSA encryption, and must be encoded using base64 encoding.

Accessible with the following methods

Method Description
GET_DOMAINSIGNINGPRIVATEKEY() Getter for DOMAINSIGNINGPRIVATEKEY, with configurable defaul
ASK_DOMAINSIGNINGPRIVATEKEY() Getter for DOMAINSIGNINGPRIVATEKEY w/ exceptions if field ha
HAS_DOMAINSIGNINGPRIVATEKEY() Determine if DOMAINSIGNINGPRIVATEKEY has a value

NextSigningKeyLength

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

Accessible with the following methods

Method Description
GET_NEXTSIGNINGKEYLENGTH() Getter for NEXTSIGNINGKEYLENGTH, with configurable default
ASK_NEXTSIGNINGKEYLENGTH() Getter for NEXTSIGNINGKEYLENGTH w/ exceptions if field has n
HAS_NEXTSIGNINGKEYLENGTH() Determine if NEXTSIGNINGKEYLENGTH has a value

DomainSigningAttributesOrigin

The attribute to use for configuring DKIM for the identity depends on the operation:

  1. For PutEmailIdentityDkimSigningAttributes:

  2. For CreateEmailIdentity when replicating a parent identity's DKIM configuration:

    • Allowed values: All values except AWS_SES and EXTERNAL

  • AWS_SES – Configure DKIM for the identity by using Easy DKIM.

  • EXTERNAL – Configure DKIM for the identity by using Bring Your Own DKIM (BYODKIM).

  • AWS_SES_ – Configure DKIM for the identity by replicating the signing attributes of a parent identity in another Amazon Web Services Region, using Deterministic Easy-DKIM (DEED). Replace with the Amazon Web Services Region of the parent identity, in uppercase with each hyphen replaced by an underscore. You can specify any Amazon Web Services Region in which Amazon SES supports DEED. For example, to replicate from a parent identity in us-east-1, specify AWS_SES_US_EAST_1.

    The parent identity must already exist in the specified Amazon Web Services Region and have Easy DKIM configured.

Accessible with the following methods

Method Description
GET_DOMAINSIGNINGATTRSORIGIN() Getter for DOMAINSIGNINGATTRSORIGIN, with configurable defau
ASK_DOMAINSIGNINGATTRSORIGIN() Getter for DOMAINSIGNINGATTRSORIGIN w/ exceptions if field h
HAS_DOMAINSIGNINGATTRSORIGIN() Determine if DOMAINSIGNINGATTRSORIGIN has a value