Class: AWSCDK::SES::ByoDkimOptions

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

Overview

Options for BYO DKIM.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(private_key:, selector:, public_key: nil) ⇒ ByoDkimOptions

Returns a new instance of ByoDkimOptions.

Parameters:

  • private_key (AWSCDK::SecretValue) —

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

  • selector (String) —

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

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

    The public key.



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

def initialize(private_key:, selector:, public_key: nil)
  @private_key = private_key
  Jsii::Type.check_type(@private_key, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5TZWNyZXRWYWx1ZSJ9")), "privateKey")
  @selector = selector
  Jsii::Type.check_type(@selector, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "selector")
  @public_key = public_key
  Jsii::Type.check_type(@public_key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "publicKey") unless @public_key.nil?
end

Instance Attribute Details

#private_key ⇒ AWSCDK::SecretValue (readonly)

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

Returns:



22
23
24
 
# File 'ses/byo_dkim_options.rb', line 22

def private_key
  @private_key
end

#public_key ⇒ String? (readonly)

Note:

Default: - the validation TXT record with the public key is not created

The public key.

If specified, a TXT record with the public key is created.

Returns:

  • (String, nil) 


33
34
35
 
# File 'ses/byo_dkim_options.rb', line 33

def public_key
  @public_key
end

#selector ⇒ String (readonly)

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

Returns:

  • (String) 


26
27
28
 
# File 'ses/byo_dkim_options.rb', line 26

def selector
  @selector
end

Class Method Details

.jsii_properties ⇒ Object 



35
36
37
38
39
40
41
 
# File 'ses/byo_dkim_options.rb', line 35

def self.jsii_properties
  {
    :private_key => "privateKey",
    :selector => "selector",
    :public_key => "publicKey",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



43
44
45
46
47
48
49
50
51
 
# File 'ses/byo_dkim_options.rb', line 43

def to_jsii
  result = {}
  result.merge!({
    "privateKey" => @private_key,
    "selector" => @selector,
    "publicKey" => @public_key,
  })
  result.compact
end