Skip to content

DkimSigningAttributes

Source code in docs_src/capo_sesv2/types/dkim_signing_attributes.py
class DkimSigningAttributes(TypedDict, closed=True):
    domain_signing_selector: NotRequired["capo_sesv2.types.selector.Selector"]
    """<p>[Bring Your Own DKIM] A string that's used to identify a public key in the DNS configuration for a domain.</p>"""
    domain_signing_private_key: NotRequired["capo_sesv2.types.private_key.PrivateKey"]
    """<p>[Bring Your Own DKIM] A private key that's used to generate a DKIM signature.</p> <p>The private key must use 1024 or 2048-bit RSA encryption, and must be encoded using base64 encoding.</p>"""
    next_signing_key_length: NotRequired[
        "capo_sesv2.types.dkim_signing_key_length.DkimSigningKeyLength"
    ]
    """<p>[Easy DKIM] The key length of the future DKIM key pair to be generated. This can be changed at most once per day.</p>"""
    domain_signing_attributes_origin: NotRequired[
        "capo_sesv2.types.dkim_signing_attributes_origin.DkimSigningAttributesOrigin"
    ]
    """<p>The attribute to use for configuring DKIM for the identity depends on the operation: </p> <ol> <li> <p>For <code>PutEmailIdentityDkimSigningAttributes</code>: </p> <ul> <li> <p>None of the values are allowed - use the <a href="https://docs.aws.amazon.com/ses/latest/APIReference-V2/API_PutEmailIdentityDkimSigningAttributes.html#SES-PutEmailIdentityDkimSigningAttributes-request-SigningAttributesOrigin"> <code>SigningAttributesOrigin</code> </a> parameter instead </p> </li> </ul> </li> <li> <p>For <code>CreateEmailIdentity</code> when replicating a parent identity's DKIM configuration: </p> <ul> <li> <p>Allowed values: All values except <code>AWS_SES</code> and <code>EXTERNAL</code> </p> </li> </ul> </li> </ol> <ul> <li> <p> <code>AWS_SES</code> – Configure DKIM for the identity by using Easy DKIM. </p> </li> <li> <p> <code>EXTERNAL</code> – Configure DKIM for the identity by using Bring Your Own DKIM (BYODKIM). </p> </li> <li> <p> <code>AWS_SES_<REGION></code> – Configure DKIM for the identity by replicating the signing attributes of a parent identity in another Amazon Web Services Region, using <a href="https://docs.aws.amazon.com/ses/latest/dg/send-email-authentication-dkim-deed.html">Deterministic Easy-DKIM (DEED)</a>. Replace <code><REGION></code> 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 <code>us-east-1</code>, specify <code>AWS_SES_US_EAST_1</code>.</p> <note> <p>The parent identity must already exist in the specified Amazon Web Services Region and have Easy DKIM configured.</p> </note> </li> </ul>"""

domain_signing_attributes_origin instance-attribute

domain_signing_attributes_origin: NotRequired[DkimSigningAttributesOrigin]

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.

domain_signing_private_key instance-attribute

domain_signing_private_key: NotRequired[PrivateKey]

[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.

domain_signing_selector instance-attribute

domain_signing_selector: NotRequired[Selector]

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

next_signing_key_length instance-attribute

next_signing_key_length: NotRequired[DkimSigningKeyLength]

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