Class: AWSCDK::SES::Identity

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

Overview

Identity.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Identity

Returns a new instance of Identity.



8
9
10
 
# File 'ses/identity.rb', line 8

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

Class Method Details

.domain(domain) ⇒ AWSCDK::SES::Identity

Verify a domain name.

DKIM records will have to be added manually to complete the verification process

Parameters:

  • domain (String)

Returns:

  • (AWSCDK::SES::Identity) 


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

def self.domain(domain)
  Jsii::Type.check_type(domain, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domain")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ses.Identity", "domain", [domain])
end

.email(email) ⇒ AWSCDK::SES::Identity

Verify an email address.

To complete the verification process look for an email from no-reply-aws@amazon.com, open it and click the link.

Parameters:

  • email (String)

Returns:

  • (AWSCDK::SES::Identity) 


38
39
40
41
 
# File 'ses/identity.rb', line 38

def self.email(email)
  Jsii::Type.check_type(email, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "email")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ses.Identity", "email", [email])
end

.jsii_overridable_methods ⇒ Object 



12
13
14
15
16
17
 
# File 'ses/identity.rb', line 12

def self.jsii_overridable_methods
  {
    :value => { kind: :property, name: "value", is_optional: false },
    :hosted_zone => { kind: :property, name: "hostedZone", is_optional: true },
  }
end

.public_hosted_zone(hosted_zone) ⇒ AWSCDK::SES::Identity

Verify a public hosted zone.

DKIM and MAIL FROM records will be added automatically to the hosted zone

Parameters:

Returns:

  • (AWSCDK::SES::Identity) 


50
51
52
53
 
# File 'ses/identity.rb', line 50

def self.public_hosted_zone(hosted_zone)
  Jsii::Type.check_type(hosted_zone, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfcm91dGU1My5JUHVibGljSG9zdGVkWm9uZSJ9")), "hostedZone")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ses.Identity", "publicHostedZone", [hosted_zone])
end

Instance Method Details

#hosted_zone ⇒ AWSCDK::Route53::IPublicHostedZone?

Note:

Default: - no hosted zone is associated and no records are created

The hosted zone associated with this identity.

Returns:



66
67
68
 
# File 'ses/identity.rb', line 66

def hosted_zone()
  jsii_get_property("hostedZone")
end

#value ⇒ String

The value of the identity.

Returns:

  • (String) 


58
59
60
 
# File 'ses/identity.rb', line 58

def value()
  jsii_get_property("value")
end