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

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

Overview

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

Constant Summary collapse

SENSITIVE =
[:domain_signing_private_key]

Instance Attribute Summary collapse

Instance Attribute Details

#domain_signing_attributes_originString

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

  1. For ‘PutEmailIdentityDkimSigningAttributes`:

    • None of the values are allowed - use the [ ‘SigningAttributesOrigin` ][1] parameter instead

    ^

  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_AF_SOUTH_1` – Configure DKIM for the identity by replicating from a parent identity in Africa (Cape Town) region using Deterministic Easy-DKIM (DEED).

  • ‘AWS_SES_EU_NORTH_1` – Configure DKIM for the identity by replicating from a parent identity in Europe (Stockholm) region using Deterministic Easy-DKIM (DEED).

  • ‘AWS_SES_AP_SOUTH_1` – Configure DKIM for the identity by replicating from a parent identity in Asia Pacific (Mumbai) region using Deterministic Easy-DKIM (DEED).

  • ‘AWS_SES_EU_WEST_3` – Configure DKIM for the identity by replicating from a parent identity in Europe (Paris) region using Deterministic Easy-DKIM (DEED).

  • ‘AWS_SES_EU_WEST_2` – Configure DKIM for the identity by replicating from a parent identity in Europe (London) region using Deterministic Easy-DKIM (DEED).

  • ‘AWS_SES_EU_SOUTH_1` – Configure DKIM for the identity by replicating from a parent identity in Europe (Milan) region using Deterministic Easy-DKIM (DEED).

  • ‘AWS_SES_EU_WEST_1` – Configure DKIM for the identity by replicating from a parent identity in Europe (Ireland) region using Deterministic Easy-DKIM (DEED).

  • ‘AWS_SES_AP_NORTHEAST_3` – Configure DKIM for the identity by replicating from a parent identity in Asia Pacific (Osaka) region using Deterministic Easy-DKIM (DEED).

  • ‘AWS_SES_AP_NORTHEAST_2` – Configure DKIM for the identity by replicating from a parent identity in Asia Pacific (Seoul) region using Deterministic Easy-DKIM (DEED).

  • ‘AWS_SES_ME_SOUTH_1` – Configure DKIM for the identity by replicating from a parent identity in Middle East (Bahrain) region using Deterministic Easy-DKIM (DEED).

  • ‘AWS_SES_AP_NORTHEAST_1` – Configure DKIM for the identity by replicating from a parent identity in Asia Pacific (Tokyo) region using Deterministic Easy-DKIM (DEED).

  • ‘AWS_SES_IL_CENTRAL_1` – Configure DKIM for the identity by replicating from a parent identity in Israel (Tel Aviv) region using Deterministic Easy-DKIM (DEED).

  • ‘AWS_SES_SA_EAST_1` – Configure DKIM for the identity by replicating from a parent identity in South America (São Paulo) region using Deterministic Easy-DKIM (DEED).

  • ‘AWS_SES_CA_CENTRAL_1` – Configure DKIM for the identity by replicating from a parent identity in Canada (Central) region using Deterministic Easy-DKIM (DEED).

  • ‘AWS_SES_AP_SOUTHEAST_1` – Configure DKIM for the identity by replicating from a parent identity in Asia Pacific (Singapore) region using Deterministic Easy-DKIM (DEED).

  • ‘AWS_SES_AP_SOUTHEAST_2` – Configure DKIM for the identity by replicating from a parent identity in Asia Pacific (Sydney) region using Deterministic Easy-DKIM (DEED).

  • ‘AWS_SES_AP_SOUTHEAST_3` – Configure DKIM for the identity by replicating from a parent identity in Asia Pacific (Jakarta) region using Deterministic Easy-DKIM (DEED).

  • ‘AWS_SES_EU_CENTRAL_1` – Configure DKIM for the identity by replicating from a parent identity in Europe (Frankfurt) region using Deterministic Easy-DKIM (DEED).

  • ‘AWS_SES_US_EAST_1` – Configure DKIM for the identity by replicating from a parent identity in US East (N. Virginia) region using Deterministic Easy-DKIM (DEED).

  • ‘AWS_SES_US_EAST_2` – Configure DKIM for the identity by replicating from a parent identity in US East (Ohio) region using Deterministic Easy-DKIM (DEED).

  • ‘AWS_SES_US_WEST_1` – Configure DKIM for the identity by replicating from a parent identity in US West (N. California) region using Deterministic Easy-DKIM (DEED).

  • ‘AWS_SES_US_WEST_2` – Configure DKIM for the identity by replicating from a parent identity in US West (Oregon) region using Deterministic Easy-DKIM (DEED).

[1]: docs.aws.amazon.com/ses/latest/APIReference-V2/API_PutEmailIdentityDkimSigningAttributes.html#SES-PutEmailIdentityDkimSigningAttributes-request-SigningAttributesOrigin

Returns:

  • (String)


2238
2239
2240
2241
2242
2243
2244
2245
# File 'lib/aws-sdk-sesv2/types.rb', line 2238

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_keyString

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


2238
2239
2240
2241
2242
2243
2244
2245
# File 'lib/aws-sdk-sesv2/types.rb', line 2238

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_selectorString

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

Returns:

  • (String)


2238
2239
2240
2241
2242
2243
2244
2245
# File 'lib/aws-sdk-sesv2/types.rb', line 2238

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_lengthString

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


2238
2239
2240
2241
2242
2243
2244
2245
# File 'lib/aws-sdk-sesv2/types.rb', line 2238

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