Class: AWSCDK::SES::DkimIdentity

Inherits:

Jsii::Object

• Object
• Jsii::Object
• AWSCDK::SES::DkimIdentity

Defined in:

ses/dkim_identity.rb

Overview

The identity to use for DKIM.

Class Method Summary

• .byo_dkim(options) ⇒ AWSCDK::SES::DkimIdentity

  Bring Your Own DKIM.

• .easy_dkim(signing_key_length = nil) ⇒ AWSCDK::SES::DkimIdentity

  Easy DKIM.

• .jsii_overridable_methods ⇒ Object

Instance Method Summary

• #bind(email_identity, hosted_zone = nil) ⇒ AWSCDK::SES::DkimIdentityConfig^?

  Binds this DKIM identity to the email identity.

• #initialize ⇒ DkimIdentity constructor

  A new instance of DkimIdentity.

Constructor Details

#initialize ⇒ DkimIdentity

Returns a new instance of DkimIdentity.

# File 'ses/dkim_identity.rb', line 8

def initialize
  Jsii::Object.instance_method(:initialize).bind(self).call
end

Class Method Details

.byo_dkim(options) ⇒ AWSCDK::SES::DkimIdentity

Bring Your Own DKIM.

Parameters:

• options (AWSCDK::SES::ByoDkimOptions) —

  Options for BYO DKIM.

Returns:

• (AWSCDK::SES::DkimIdentity)

See Also:

• https://docs.aws.amazon.com/ses/latest/dg/send-email-authentication-dkim-bring-your-own.html

# File 'ses/dkim_identity.rb', line 23

def self.byo_dkim(options)
  options = options.is_a?(Hash) ? ::AWSCDK::SES::ByoDkimOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2VzLkJ5b0RraW1PcHRpb25zIn0=")), "options")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ses.DkimIdentity", "byoDkim", [options])
end

.easy_dkim(signing_key_length = nil) ⇒ AWSCDK::SES::DkimIdentity

Easy DKIM.

Parameters:

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

  The length of the signing key.

Returns:

• (AWSCDK::SES::DkimIdentity)

See Also:

• https://docs.aws.amazon.com/ses/latest/dg/send-email-authentication-dkim-easy.html

# File 'ses/dkim_identity.rb', line 34

def self.easy_dkim(signing_key_length = nil)
  Jsii::Type.check_type(signing_key_length, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2VzLkVhc3lEa2ltU2lnbmluZ0tleUxlbmd0aCJ9")), "signingKeyLength") unless signing_key_length.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ses.DkimIdentity", "easyDkim", [signing_key_length])
end

.jsii_overridable_methods ⇒ Object

# File 'ses/dkim_identity.rb', line 12

def self.jsii_overridable_methods
  {
    :bind => { kind: :method, name: "bind", is_optional: false },
  }
end

Instance Method Details

#bind(email_identity, hosted_zone = nil) ⇒ AWSCDK::SES::DkimIdentityConfig^?

Binds this DKIM identity to the email identity.

Parameters:

• email_identity (AWSCDK::SES::EmailIdentity)
• hosted_zone (AWSCDK::Route53::IPublicHostedZone, nil) (defaults to: nil)

Returns:

• (AWSCDK::SES::DkimIdentityConfig, nil)

# File 'ses/dkim_identity.rb', line 44

def bind(email_identity, hosted_zone = nil)
  Jsii::Type.check_type(email_identity, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2VzLkVtYWlsSWRlbnRpdHkifQ==")), "emailIdentity")
  Jsii::Type.check_type(hosted_zone, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfcm91dGU1My5JUHVibGljSG9zdGVkWm9uZSJ9")), "hostedZone") unless hosted_zone.nil?
  jsii_call_method("bind", [email_identity, hosted_zone])
end