Class: AWSCDK::SES::DkimIdentityConfig

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
ses/dkim_identity_config.rb

Overview

Configuration for DKIM identity.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(domain_signing_private_key: nil, domain_signing_selector: nil, next_signing_key_length: nil) ⇒ DkimIdentityConfig

Returns a new instance of DkimIdentityConfig.

Parameters:

  • domain_signing_private_key (String, nil) (defaults to: nil) —

    A private key that's used to generate a DKIM signature.

  • domain_signing_selector (String, nil) (defaults to: nil) —

    A string that's used to identify a public key in the DNS configuration for a domain.

  • next_signing_key_length (AWSCDK::SES::EasyDkimSigningKeyLength, nil) (defaults to: nil) —

    The key length of the future DKIM key pair to be generated.



10
11
12
13
14
15
16
17
 
# File 'ses/dkim_identity_config.rb', line 10

def initialize(domain_signing_private_key: nil, domain_signing_selector: nil, next_signing_key_length: nil)
  @domain_signing_private_key = domain_signing_private_key
  Jsii::Type.check_type(@domain_signing_private_key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domainSigningPrivateKey") unless @domain_signing_private_key.nil?
  @domain_signing_selector = domain_signing_selector
  Jsii::Type.check_type(@domain_signing_selector, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domainSigningSelector") unless @domain_signing_selector.nil?
  @next_signing_key_length = next_signing_key_length
  Jsii::Type.check_type(@next_signing_key_length, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2VzLkVhc3lEa2ltU2lnbmluZ0tleUxlbmd0aCJ9")), "nextSigningKeyLength") unless @next_signing_key_length.nil?
end

Instance Attribute Details

#domain_signing_private_key ⇒ String? (readonly)

Note:

Default: - use Easy DKIM

A private key that's used to generate a DKIM signature.

Returns:

  • (String, nil) 


23
24
25
 
# File 'ses/dkim_identity_config.rb', line 23

def domain_signing_private_key
  @domain_signing_private_key
end

#domain_signing_selector ⇒ String? (readonly)

Note:

Default: - use Easy DKIM

A string that's used to identify a public key in the DNS configuration for a domain.

Returns:

  • (String, nil) 


28
29
30
 
# File 'ses/dkim_identity_config.rb', line 28

def domain_signing_selector
  @domain_signing_selector
end

#next_signing_key_length ⇒ AWSCDK::SES::EasyDkimSigningKeyLength? (readonly)

Note:

Default: EasyDkimSigningKeyLength.RSA_2048_BIT

The key length of the future DKIM key pair to be generated.

This can be changed at most once per day.

Returns:



36
37
38
 
# File 'ses/dkim_identity_config.rb', line 36

def next_signing_key_length
  @next_signing_key_length
end

Class Method Details

.jsii_properties ⇒ Object 



38
39
40
41
42
43
44
 
# File 'ses/dkim_identity_config.rb', line 38

def self.jsii_properties
  {
    :domain_signing_private_key => "domainSigningPrivateKey",
    :domain_signing_selector => "domainSigningSelector",
    :next_signing_key_length => "nextSigningKeyLength",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



46
47
48
49
50
51
52
53
54
 
# File 'ses/dkim_identity_config.rb', line 46

def to_jsii
  result = {}
  result.merge!({
    "domainSigningPrivateKey" => @domain_signing_private_key,
    "domainSigningSelector" => @domain_signing_selector,
    "nextSigningKeyLength" => @next_signing_key_length,
  })
  result.compact
end