Class: Aws::SESV2::Types::DkimAttributes

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb

Overview

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:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#current_signing_key_length ⇒ String

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

Returns:

  • (String) 


2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
 
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 2352

class DkimAttributes < Struct.new(
  :signing_enabled,
  :status,
  :tokens,
  :signing_hosted_zone,
  :signing_attributes_origin,
  :next_signing_key_length,
  :current_signing_key_length,
  :last_key_generation_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#last_key_generation_timestamp ⇒ Time

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

Returns:

  • (Time) 


2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
 
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 2352

class DkimAttributes < Struct.new(
  :signing_enabled,
  :status,
  :tokens,
  :signing_hosted_zone,
  :signing_attributes_origin,
  :next_signing_key_length,
  :current_signing_key_length,
  :last_key_generation_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#next_signing_key_length ⇒ String

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

Returns:

  • (String) 


2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
 
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 2352

class DkimAttributes < Struct.new(
  :signing_enabled,
  :status,
  :tokens,
  :signing_hosted_zone,
  :signing_attributes_origin,
  :next_signing_key_length,
  :current_signing_key_length,
  :last_key_generation_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#signing_attributes_origin ⇒ String

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

  • AWS_SES_AF_SOUTH_1 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Africa (Cape Town) region using Deterministic Easy-DKIM (DEED).

  • AWS_SES_EU_NORTH_1 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Europe (Stockholm) region using Deterministic Easy-DKIM (DEED).

  • AWS_SES_AP_SOUTH_1 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Asia Pacific (Mumbai) region using Deterministic Easy-DKIM (DEED).

  • AWS_SES_AP_SOUTH_2 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Asia Pacific (Hyderabad) region using Deterministic Easy-DKIM (DEED).

  • AWS_SES_EU_WEST_3 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Europe (Paris) region using Deterministic Easy-DKIM (DEED).

  • AWS_SES_EU_WEST_2 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Europe (London) region using Deterministic Easy-DKIM (DEED).

  • AWS_SES_EU_SOUTH_1 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Europe (Milan) region using Deterministic Easy-DKIM (DEED).

  • AWS_SES_EU_WEST_1 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Europe (Ireland) region using Deterministic Easy-DKIM (DEED).

  • AWS_SES_AP_NORTHEAST_3 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Asia Pacific (Osaka) region using Deterministic Easy-DKIM (DEED).

  • AWS_SES_AP_NORTHEAST_2 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Asia Pacific (Seoul) region using Deterministic Easy-DKIM (DEED).

  • AWS_SES_ME_CENTRAL_1 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Middle East (UAE) region using Deterministic Easy-DKIM (DEED).

  • AWS_SES_ME_SOUTH_1 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Middle East (Bahrain) region using Deterministic Easy-DKIM (DEED).

  • AWS_SES_AP_NORTHEAST_1 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Asia Pacific (Tokyo) region using Deterministic Easy-DKIM (DEED).

  • AWS_SES_IL_CENTRAL_1 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Israel (Tel Aviv) region using Deterministic Easy-DKIM (DEED).

  • AWS_SES_SA_EAST_1 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in South America (São Paulo) region using Deterministic Easy-DKIM (DEED).

  • AWS_SES_CA_CENTRAL_1 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Canada (Central) region using Deterministic Easy-DKIM (DEED).

  • AWS_SES_CA_WEST_1 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Canada (Calgary) region using Deterministic Easy-DKIM (DEED).

  • AWS_SES_AP_SOUTHEAST_1 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Asia Pacific (Singapore) region using Deterministic Easy-DKIM (DEED).

  • AWS_SES_AP_SOUTHEAST_2 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Asia Pacific (Sydney) region using Deterministic Easy-DKIM (DEED).

  • AWS_SES_AP_SOUTHEAST_3 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Asia Pacific (Jakarta) region using Deterministic Easy-DKIM (DEED).

  • AWS_SES_AP_SOUTHEAST_5 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Asia Pacific (Malaysia) region using Deterministic Easy-DKIM (DEED).

  • AWS_SES_EU_CENTRAL_1 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Europe (Frankfurt) region using Deterministic Easy-DKIM (DEED).

  • AWS_SES_EU_CENTRAL_2 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Europe (Zurich) region using Deterministic Easy-DKIM (DEED).

  • AWS_SES_US_EAST_1 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in US East (N. Virginia) region using Deterministic Easy-DKIM (DEED).

  • AWS_SES_US_EAST_2 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in US East (Ohio) region using Deterministic Easy-DKIM (DEED).

  • AWS_SES_US_WEST_1 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in US West (N. California) region using Deterministic Easy-DKIM (DEED).

  • AWS_SES_US_WEST_2 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in US West (Oregon) region using Deterministic Easy-DKIM (DEED).

Returns:

  • (String) 


2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
 
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 2352

class DkimAttributes < Struct.new(
  :signing_enabled,
  :status,
  :tokens,
  :signing_hosted_zone,
  :signing_attributes_origin,
  :next_signing_key_length,
  :current_signing_key_length,
  :last_key_generation_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#signing_enabled ⇒ Boolean

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:

  • (Boolean) 


2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
 
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 2352

class DkimAttributes < Struct.new(
  :signing_enabled,
  :status,
  :tokens,
  :signing_hosted_zone,
  :signing_attributes_origin,
  :next_signing_key_length,
  :current_signing_key_length,
  :last_key_generation_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#signing_hosted_zone ⇒ String

The hosted zone where Amazon SES publishes the DKIM public key TXT records for this email identity. This value indicates the DNS zone that customers must reference when configuring their CNAME records for DKIM authentication.

When configuring DKIM for your domain, create CNAME records in your DNS that point to the selectors in this hosted zone. For example:

selector1._domainkey.yourdomain.com CNAME selector1.<SigningHostedZone>

selector2._domainkey.yourdomain.com CNAME selector2.<SigningHostedZone>

selector3._domainkey.yourdomain.com CNAME selector3.<SigningHostedZone>

Returns:

  • (String) 


2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
 
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 2352

class DkimAttributes < Struct.new(
  :signing_enabled,
  :status,
  :tokens,
  :signing_hosted_zone,
  :signing_attributes_origin,
  :next_signing_key_length,
  :current_signing_key_length,
  :last_key_generation_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

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:

  • (String) 


2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
 
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 2352

class DkimAttributes < Struct.new(
  :signing_enabled,
  :status,
  :tokens,
  :signing_hosted_zone,
  :signing_attributes_origin,
  :next_signing_key_length,
  :current_signing_key_length,
  :last_key_generation_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#tokens ⇒ Array<String>

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:

  • (Array<String>) 


2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
 
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 2352

class DkimAttributes < Struct.new(
  :signing_enabled,
  :status,
  :tokens,
  :signing_hosted_zone,
  :signing_attributes_origin,
  :next_signing_key_length,
  :current_signing_key_length,
  :last_key_generation_timestamp)
  SENSITIVE = []
  include Aws::Structure
end