Class: AWSCDK::SES::EmailIdentity

Inherits:
Resource
  • Object
show all
Includes:
IEmailIdentity
Defined in:
ses/email_identity.rb

Overview

An email identity.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ EmailIdentity

Returns a new instance of EmailIdentity.

Parameters:



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

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::SES::EmailIdentityProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2VzLkVtYWlsSWRlbnRpdHlQcm9wcyJ9")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.from_email_identity_arn(scope, id, email_identity_arn) ⇒ AWSCDK::SES::IEmailIdentity

Import an email identity by ARN.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • email_identity_arn (String)

Returns:



54
55
56
57
58
59
 
# File 'ses/email_identity.rb', line 54

def self.from_email_identity_arn(scope, id, email_identity_arn)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(email_identity_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "emailIdentityArn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ses.EmailIdentity", "fromEmailIdentityArn", [scope, id, email_identity_arn])
end

.from_email_identity_name(scope, id, email_identity_name) ⇒ AWSCDK::SES::IEmailIdentity

Use an existing email identity.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • email_identity_name (String)

Returns:



67
68
69
70
71
72
 
# File 'ses/email_identity.rb', line 67

def self.from_email_identity_name(scope, id, email_identity_name)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(email_identity_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "emailIdentityName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ses.EmailIdentity", "fromEmailIdentityName", [scope, id, email_identity_name])
end

.jsii_overridable_methods ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'ses/email_identity.rb', line 20

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :physical_name => { kind: :property, name: "physicalName", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :dkim_dns_token_name1 => { kind: :property, name: "dkimDnsTokenName1", is_optional: false },
    :dkim_dns_token_name2 => { kind: :property, name: "dkimDnsTokenName2", is_optional: false },
    :dkim_dns_token_name3 => { kind: :property, name: "dkimDnsTokenName3", is_optional: false },
    :dkim_dns_token_value1 => { kind: :property, name: "dkimDnsTokenValue1", is_optional: false },
    :dkim_dns_token_value2 => { kind: :property, name: "dkimDnsTokenValue2", is_optional: false },
    :dkim_dns_token_value3 => { kind: :property, name: "dkimDnsTokenValue3", is_optional: false },
    :dkim_records => { kind: :property, name: "dkimRecords", is_optional: false },
    :email_identity_arn => { kind: :property, name: "emailIdentityArn", is_optional: false },
    :email_identity_name => { kind: :property, name: "emailIdentityName", is_optional: false },
    :email_identity_ref => { kind: :property, name: "emailIdentityRef", is_optional: false },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :generate_physical_name => { kind: :method, name: "generatePhysicalName", is_optional: false },
    :get_resource_arn_attribute => { kind: :method, name: "getResourceArnAttribute", is_optional: false },
    :get_resource_name_attribute => { kind: :method, name: "getResourceNameAttribute", is_optional: false },
    :grant => { kind: :method, name: "grant", is_optional: false },
    :grant_send_email => { kind: :method, name: "grantSendEmail", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


120
121
122
 
# File 'ses/email_identity.rb', line 120

def self.PROPERTY_INJECTION_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ses.EmailIdentity", "PROPERTY_INJECTION_ID")
end

Instance Method Details

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters:



227
228
229
230
 
# File 'ses/email_identity.rb', line 227

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy) ⇒ void

This method returns an undefined value.

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:



244
245
246
247
 
# File 'ses/email_identity.rb', line 244

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
end

#dkim_dns_token_name1 ⇒ String

The host name for the first token that you have to add to the DNS configurationfor your domain.

Returns:

  • (String) 


127
128
129
 
# File 'ses/email_identity.rb', line 127

def dkim_dns_token_name1()
  jsii_get_property("dkimDnsTokenName1")
end

#dkim_dns_token_name2 ⇒ String

The host name for the second token that you have to add to the DNS configuration for your domain.

Returns:

  • (String) 


134
135
136
 
# File 'ses/email_identity.rb', line 134

def dkim_dns_token_name2()
  jsii_get_property("dkimDnsTokenName2")
end

#dkim_dns_token_name3 ⇒ String

The host name for the third token that you have to add to the DNS configuration for your domain.

Returns:

  • (String) 


141
142
143
 
# File 'ses/email_identity.rb', line 141

def dkim_dns_token_name3()
  jsii_get_property("dkimDnsTokenName3")
end

#dkim_dns_token_value1 ⇒ String

The record value for the first token that you have to add to the DNS configuration for your domain.

Returns:

  • (String) 


148
149
150
 
# File 'ses/email_identity.rb', line 148

def dkim_dns_token_value1()
  jsii_get_property("dkimDnsTokenValue1")
end

#dkim_dns_token_value2 ⇒ String

The record value for the second token that you have to add to the DNS configuration for your domain.

Returns:

  • (String) 


155
156
157
 
# File 'ses/email_identity.rb', line 155

def dkim_dns_token_value2()
  jsii_get_property("dkimDnsTokenValue2")
end

#dkim_dns_token_value3 ⇒ String

The record value for the third token that you have to add to the DNS configuration for your domain.

Returns:

  • (String) 


162
163
164
 
# File 'ses/email_identity.rb', line 162

def dkim_dns_token_value3()
  jsii_get_property("dkimDnsTokenValue3")
end

#dkim_records ⇒ Array<AWSCDK::SES::DkimRecord>

DKIM records for this identity.

Returns:



169
170
171
 
# File 'ses/email_identity.rb', line 169

def dkim_records()
  jsii_get_property("dkimRecords")
end

#email_identity_arn ⇒ String

The ARN of the email identity.

Returns:

  • (String) 


176
177
178
 
# File 'ses/email_identity.rb', line 176

def email_identity_arn()
  jsii_get_property("emailIdentityArn")
end

#email_identity_name ⇒ String

The name of the email identity.

Returns:

  • (String) 


183
184
185
 
# File 'ses/email_identity.rb', line 183

def email_identity_name()
  jsii_get_property("emailIdentityName")
end

#email_identity_ref ⇒ AWSCDK::Interfaces::AWSSES::EmailIdentityReference

A reference to a EmailIdentity resource.

Returns:



190
191
192
 
# File 'ses/email_identity.rb', line 190

def email_identity_ref()
  jsii_get_property("emailIdentityRef")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Returns:



92
93
94
 
# File 'ses/email_identity.rb', line 92

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


250
251
252
 
# File 'ses/email_identity.rb', line 250

def generate_physical_name()
  jsii_call_method("generatePhysicalName", [])
end

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arn_attr, but if the resource is referenced across environments, arn_components will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arn_components.

Parameters:

  • arn_attr (String) —

    The CFN attribute which resolves to the ARN of the resource.

  • arn_components (AWSCDK::ARNComponents) —

    The format of the ARN of this resource.

Returns:

  • (String) 


264
265
266
267
268
269
 
# File 'ses/email_identity.rb', line 264

def get_resource_arn_attribute(arn_attr, arn_components)
  Jsii::Type.check_type(arn_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arnAttr")
  arn_components = arn_components.is_a?(Hash) ? ::AWSCDK::ARNComponents.new(**arn_components.transform_keys(&:to_sym)) : arn_components
  Jsii::Type.check_type(arn_components, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5Bcm5Db21wb25lbnRzIn0=")), "arnComponents")
  jsii_call_method("getResourceArnAttribute", [arn_attr, arn_components])
end

#get_resource_name_attribute(name_attr) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

Normally, this token will resolve to name_attr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters:

  • name_attr (String) —

    The CFN attribute which resolves to the resource's name.

Returns:

  • (String) 


279
280
281
282
 
# File 'ses/email_identity.rb', line 279

def get_resource_name_attribute(name_attr)
  Jsii::Type.check_type(name_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nameAttr")
  jsii_call_method("getResourceNameAttribute", [name_attr])
end

#grant(grantee, *actions) ⇒ AWSCDK::IAM::Grant

Adds an IAM policy statement associated with this email identity to an IAM principal's policy.

[disable-awslint:no-grants]

Parameters:

  • grantee (AWSCDK::IAM::IGrantable) —

    the principal (no-op if undefined).

  • actions (Array<String>) —

    the set of actions to allow.

Returns:



291
292
293
294
295
296
297
 
# File 'ses/email_identity.rb', line 291

def grant(grantee, *actions)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  actions.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "actions[#{index}]")
  end
  jsii_call_method("grant", [grantee, *actions])
end

#grant_send_email(grantee) ⇒ AWSCDK::IAM::Grant

Permits an IAM principal the send email action.

Actions: SendEmail, SendRawEmail.

[disable-awslint:no-grants]

Parameters:

Returns:



307
308
309
310
 
# File 'ses/email_identity.rb', line 307

def grant_send_email(grantee)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  jsii_call_method("grantSendEmail", [grantee])
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


77
78
79
 
# File 'ses/email_identity.rb', line 77

def node()
  jsii_get_property("node")
end

#physical_name ⇒ String

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.

Returns:

  • (String) 


106
107
108
 
# File 'ses/email_identity.rb', line 106

def physical_name()
  jsii_get_property("physicalName")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



113
114
115
 
# File 'ses/email_identity.rb', line 113

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


197
198
199
 
# File 'ses/email_identity.rb', line 197

def to_string()
  jsii_call_method("toString", [])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


210
211
212
213
214
215
 
# File 'ses/email_identity.rb', line 210

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end