You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::PinpointEmail::Types::DkimAttributes

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

An object that contains information about the DKIM configuration for an email identity.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#signing_enabled ⇒ Boolean

If the value is true, then the messages that Amazon Pinpoint sends from the identity are DKIM-signed. If the value is false, then the messages that Amazon Pinpoint sends from the identity aren\'t DKIM-signed.

Returns:

  • (Boolean) —

    If the value is true, then the messages that Amazon Pinpoint sends from the identity are DKIM-signed.

#status ⇒ String

Describes whether or not Amazon Pinpoint has successfully located the DKIM records in the DNS records for the domain. The status can be one of the following:

  • PENDING – Amazon Pinpoint hasn\'t yet located the DKIM records in the DNS configuration for the domain, but will continue to attempt to locate them.

  • SUCCESS – Amazon Pinpoint located the DKIM records in the DNS configuration for the domain and determined that they\'re correct. Amazon Pinpoint can now send DKIM-signed email from the identity.

  • FAILED – Amazon Pinpoint was unable to locate the DKIM records in the DNS settings for the domain, and won\'t continue to search for them.

  • TEMPORARY_FAILURE – A temporary issue occurred, which prevented Amazon Pinpoint from determining the DKIM status for the domain.

  • NOT_STARTED – Amazon Pinpoint hasn\'t yet started searching for the DKIM records in the DKIM records for the domain.

    Possible values:

    • PENDING
    • SUCCESS
    • FAILED
    • TEMPORARY_FAILURE
    • NOT_STARTED

Returns:

  • (String) —

    Describes whether or not Amazon Pinpoint has successfully located the DKIM records in the DNS records for the domain.

#tokens ⇒ Array<String>

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 Pinpoint detects these records in the DNS configuration for your domain, the DKIM authentication process is complete. Amazon Pinpoint usually detects these records within about 72 hours of adding them to the DNS configuration for your domain.

Returns:

  • (Array<String>) —

    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.