Class: Aws::SESV2::Types::DkimSigningAttributes

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

Overview

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

See Also:

Constant Summary collapse

SENSITIVE = 
[:domain_signing_private_key]

Instance Attribute Summary collapse

Instance Attribute Details

#domain_signing_attributes_origin ⇒ String

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

    ^

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

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

  5. AWS_SES_<REGION> – 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 <REGION> 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.

Returns:

  • (String) 


2458
2459
2460
2461
2462
2463
2464
2465
 
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 2458

class DkimSigningAttributes < Struct.new(
  :domain_signing_selector,
  :domain_signing_private_key,
  :next_signing_key_length,
  :domain_signing_attributes_origin)
  SENSITIVE = [:domain_signing_private_key]
  include Aws::Structure
end

#domain_signing_private_key ⇒ String

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

Returns:

  • (String) 


2458
2459
2460
2461
2462
2463
2464
2465
 
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 2458

class DkimSigningAttributes < Struct.new(
  :domain_signing_selector,
  :domain_signing_private_key,
  :next_signing_key_length,
  :domain_signing_attributes_origin)
  SENSITIVE = [:domain_signing_private_key]
  include Aws::Structure
end

#domain_signing_selector ⇒ String

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

Returns:

  • (String) 


2458
2459
2460
2461
2462
2463
2464
2465
 
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 2458

class DkimSigningAttributes < Struct.new(
  :domain_signing_selector,
  :domain_signing_private_key,
  :next_signing_key_length,
  :domain_signing_attributes_origin)
  SENSITIVE = [:domain_signing_private_key]
  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) 


2458
2459
2460
2461
2462
2463
2464
2465
 
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 2458

class DkimSigningAttributes < Struct.new(
  :domain_signing_selector,
  :domain_signing_private_key,
  :next_signing_key_length,
  :domain_signing_attributes_origin)
  SENSITIVE = [:domain_signing_private_key]
  include Aws::Structure
end