Class: AWSCDK::SES::CfnEmailIdentity

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSSES::IEmailIdentityRef
Defined in:
ses/cfn_email_identity.rb

Overview

Specifies an identity for using within SES.

An identity is an email address or domain that you use when you send email. Before you can use an identity to send email, you first have to verify it. By verifying an identity, you demonstrate that you're the owner of the identity, and that you've given Amazon SES API v2 permission to send email from the identity.

When you verify an email address, SES sends an email to the address. Your email address is verified as soon as you follow the link in the verification email. When you verify a domain without specifying the DkimSigningAttributes properties, OR only the NextSigningKeyLength property of DkimSigningAttributes , this resource provides a set of CNAME token names and values ( DkimDNSTokenName1 , DkimDNSTokenValue1 , DkimDNSTokenName2 , DkimDNSTokenValue2 , DkimDNSTokenName3 , DkimDNSTokenValue3 ) as outputs. You can then add these to the DNS configuration for your domain. Your domain is verified when Amazon SES detects these records in the DNS configuration for your domain. This verification method is known as Easy DKIM.

Alternatively, you can perform the verification process by providing your own public-private key pair. This verification method is known as Bring Your Own DKIM (BYODKIM). To use BYODKIM, your resource must include DkimSigningAttributes properties DomainSigningSelector and DomainSigningPrivateKey . When you specify this object, you provide a selector ( DomainSigningSelector ) (a component of the DNS record name that identifies the public key to use for DKIM authentication) and a private key ( DomainSigningPrivateKey ).

Additionally, you can associate an existing configuration set with the email identity that you're verifying.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnEmailIdentity

Create a new AWS::SES::EmailIdentity.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::SES::CfnEmailIdentityProps) —

    Resource properties.



26
27
28
29
30
31
32
 
# File 'ses/cfn_email_identity.rb', line 26

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::SES::CfnEmailIdentityProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2VzLkNmbkVtYWlsSWRlbnRpdHlQcm9wcyJ9")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


191
192
193
 
# File 'ses/cfn_email_identity.rb', line 191

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

.is_cfn_email_identity(x) ⇒ Boolean

Checks whether the given object is a CfnEmailIdentity.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


93
94
95
96
 
# File 'ses/cfn_email_identity.rb', line 93

def self.is_cfn_email_identity(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ses.CfnEmailIdentity", "isCfnEmailIdentity", [x])
end

.jsii_overridable_methods ⇒ Object 



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'ses/cfn_email_identity.rb', line 34

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_dkim_dns_token_name1 => { kind: :property, name: "attrDkimDnsTokenName1", is_optional: false },
    :attr_dkim_dns_token_name2 => { kind: :property, name: "attrDkimDnsTokenName2", is_optional: false },
    :attr_dkim_dns_token_name3 => { kind: :property, name: "attrDkimDnsTokenName3", is_optional: false },
    :attr_dkim_dns_token_value1 => { kind: :property, name: "attrDkimDnsTokenValue1", is_optional: false },
    :attr_dkim_dns_token_value2 => { kind: :property, name: "attrDkimDnsTokenValue2", is_optional: false },
    :attr_dkim_dns_token_value3 => { kind: :property, name: "attrDkimDnsTokenValue3", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :email_identity_ref => { kind: :property, name: "emailIdentityRef", is_optional: false },
    :email_identity => { kind: :property, name: "emailIdentity", is_optional: false },
    :configuration_set_attributes => { kind: :property, name: "configurationSetAttributes", is_optional: true },
    :dkim_attributes => { kind: :property, name: "dkimAttributes", is_optional: true },
    :dkim_signing_attributes => { kind: :property, name: "dkimSigningAttributes", is_optional: true },
    :feedback_attributes => { kind: :property, name: "feedbackAttributes", is_optional: true },
    :mail_from_attributes => { kind: :property, name: "mailFromAttributes", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", 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 },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



377
378
379
380
 
# File 'ses/cfn_email_identity.rb', line 377

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



389
390
391
392
 
# File 'ses/cfn_email_identity.rb', line 389

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



399
400
401
402
 
# File 'ses/cfn_email_identity.rb', line 399

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



410
411
412
413
414
 
# File 'ses/cfn_email_identity.rb', line 410

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


467
468
469
470
471
 
# File 'ses/cfn_email_identity.rb', line 467

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



477
478
479
480
 
# File 'ses/cfn_email_identity.rb', line 477

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



489
490
491
492
493
 
# File 'ses/cfn_email_identity.rb', line 489

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



502
503
504
505
 
# File 'ses/cfn_email_identity.rb', line 502

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 = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



524
525
526
527
528
529
 
# File 'ses/cfn_email_identity.rb', line 524

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_dkim_dns_token_name1 ⇒ String

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

Returns:

  • (String) 


198
199
200
 
# File 'ses/cfn_email_identity.rb', line 198

def attr_dkim_dns_token_name1()
  jsii_get_property("attrDkimDnsTokenName1")
end

#attr_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) 


205
206
207
 
# File 'ses/cfn_email_identity.rb', line 205

def attr_dkim_dns_token_name2()
  jsii_get_property("attrDkimDnsTokenName2")
end

#attr_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) 


212
213
214
 
# File 'ses/cfn_email_identity.rb', line 212

def attr_dkim_dns_token_name3()
  jsii_get_property("attrDkimDnsTokenName3")
end

#attr_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) 


219
220
221
 
# File 'ses/cfn_email_identity.rb', line 219

def attr_dkim_dns_token_value1()
  jsii_get_property("attrDkimDnsTokenValue1")
end

#attr_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) 


226
227
228
 
# File 'ses/cfn_email_identity.rb', line 226

def attr_dkim_dns_token_value2()
  jsii_get_property("attrDkimDnsTokenValue2")
end

#attr_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) 


233
234
235
 
# File 'ses/cfn_email_identity.rb', line 233

def attr_dkim_dns_token_value3()
  jsii_get_property("attrDkimDnsTokenValue3")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



240
241
242
 
# File 'ses/cfn_email_identity.rb', line 240

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



144
145
146
 
# File 'ses/cfn_email_identity.rb', line 144

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


149
150
151
 
# File 'ses/cfn_email_identity.rb', line 149

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


533
534
535
536
 
# File 'ses/cfn_email_identity.rb', line 533

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


154
155
156
 
# File 'ses/cfn_email_identity.rb', line 154

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


161
162
163
 
# File 'ses/cfn_email_identity.rb', line 161

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#configuration_set_attributes ⇒ AWSCDK::IResolvable, ...

Used to associate a configuration set with an email identity.

Returns:



266
267
268
 
# File 'ses/cfn_email_identity.rb', line 266

def configuration_set_attributes()
  jsii_get_property("configurationSetAttributes")
end

#configuration_set_attributes=(value) ⇒ Object 



270
271
272
273
274
 
# File 'ses/cfn_email_identity.rb', line 270

def configuration_set_attributes=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::SES::CfnEmailIdentity::ConfigurationSetAttributesProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zZXMuQ2ZuRW1haWxJZGVudGl0eS5Db25maWd1cmF0aW9uU2V0QXR0cmlidXRlc1Byb3BlcnR5In1dfX0=")), "configurationSetAttributes") unless value.nil?
  jsii_set_property("configurationSetAttributes", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


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

def creation_stack()
  jsii_get_property("creationStack")
end

#dkim_attributes ⇒ AWSCDK::IResolvable, ...

An object that contains information about the DKIM attributes for the identity.

Returns:



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

def dkim_attributes()
  jsii_get_property("dkimAttributes")
end

#dkim_attributes=(value) ⇒ Object 



283
284
285
286
287
 
# File 'ses/cfn_email_identity.rb', line 283

def dkim_attributes=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::SES::CfnEmailIdentity::DkimAttributesProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zZXMuQ2ZuRW1haWxJZGVudGl0eS5Ea2ltQXR0cmlidXRlc1Byb3BlcnR5In1dfX0=")), "dkimAttributes") unless value.nil?
  jsii_set_property("dkimAttributes", value)
end

#dkim_signing_attributes ⇒ AWSCDK::IResolvable, ...

If your request includes this object, Amazon SES configures the identity to use Bring Your Own DKIM (BYODKIM) for DKIM authentication purposes, or, configures the key length to be used for Easy DKIM .

Returns:



292
293
294
 
# File 'ses/cfn_email_identity.rb', line 292

def dkim_signing_attributes()
  jsii_get_property("dkimSigningAttributes")
end

#dkim_signing_attributes=(value) ⇒ Object 



296
297
298
299
300
 
# File 'ses/cfn_email_identity.rb', line 296

def dkim_signing_attributes=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::SES::CfnEmailIdentity::DkimSigningAttributesProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zZXMuQ2ZuRW1haWxJZGVudGl0eS5Ea2ltU2lnbmluZ0F0dHJpYnV0ZXNQcm9wZXJ0eSJ9XX19")), "dkimSigningAttributes") unless value.nil?
  jsii_set_property("dkimSigningAttributes", value)
end

#email_identity ⇒ String

The email address or domain to verify.

Returns:

  • (String) 


254
255
256
 
# File 'ses/cfn_email_identity.rb', line 254

def email_identity()
  jsii_get_property("emailIdentity")
end

#email_identity=(value) ⇒ Object 



258
259
260
261
 
# File 'ses/cfn_email_identity.rb', line 258

def email_identity=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "emailIdentity")
  jsii_set_property("emailIdentity", value)
end

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

A reference to a EmailIdentity resource.

Returns:



247
248
249
 
# File 'ses/cfn_email_identity.rb', line 247

def email_identity_ref()
  jsii_get_property("emailIdentityRef")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



166
167
168
 
# File 'ses/cfn_email_identity.rb', line 166

def env()
  jsii_get_property("env")
end

#feedback_attributes ⇒ AWSCDK::IResolvable, ...

Used to enable or disable feedback forwarding for an identity.

Returns:



305
306
307
 
# File 'ses/cfn_email_identity.rb', line 305

def feedback_attributes()
  jsii_get_property("feedbackAttributes")
end

#feedback_attributes=(value) ⇒ Object 



309
310
311
312
313
 
# File 'ses/cfn_email_identity.rb', line 309

def feedback_attributes=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::SES::CfnEmailIdentity::FeedbackAttributesProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zZXMuQ2ZuRW1haWxJZGVudGl0eS5GZWVkYmFja0F0dHJpYnV0ZXNQcm9wZXJ0eSJ9XX19")), "feedbackAttributes") unless value.nil?
  jsii_set_property("feedbackAttributes", value)
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



546
547
548
549
550
 
# File 'ses/cfn_email_identity.rb', line 546

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



557
558
559
560
 
# File 'ses/cfn_email_identity.rb', line 557

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



627
628
629
630
 
# File 'ses/cfn_email_identity.rb', line 627

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


118
119
120
 
# File 'ses/cfn_email_identity.rb', line 118

def logical_id()
  jsii_get_property("logicalId")
end

#mail_from_attributes ⇒ AWSCDK::IResolvable, ...

Used to enable or disable the custom Mail-From domain configuration for an email identity.

Returns:



318
319
320
 
# File 'ses/cfn_email_identity.rb', line 318

def mail_from_attributes()
  jsii_get_property("mailFromAttributes")
end

#mail_from_attributes=(value) ⇒ Object 



322
323
324
325
326
 
# File 'ses/cfn_email_identity.rb', line 322

def mail_from_attributes=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::SES::CfnEmailIdentity::MailFromAttributesProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zZXMuQ2ZuRW1haWxJZGVudGl0eS5NYWlsRnJvbUF0dHJpYnV0ZXNQcm9wZXJ0eSJ9XX19")), "mailFromAttributes") unless value.nil?
  jsii_set_property("mailFromAttributes", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


101
102
103
 
# File 'ses/cfn_email_identity.rb', line 101

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



568
569
570
 
# File 'ses/cfn_email_identity.rb', line 568

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



575
576
577
 
# File 'ses/cfn_email_identity.rb', line 575

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



368
369
370
371
 
# File 'ses/cfn_email_identity.rb', line 368

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


137
138
139
 
# File 'ses/cfn_email_identity.rb', line 137

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



586
587
588
589
 
# File 'ses/cfn_email_identity.rb', line 586

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


593
594
595
596
 
# File 'ses/cfn_email_identity.rb', line 593

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



603
604
605
606
607
 
# File 'ses/cfn_email_identity.rb', line 603

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



612
613
614
 
# File 'ses/cfn_email_identity.rb', line 612

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



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

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Array<AWSCDK::CfnTag>?

An array of objects that define the tags (keys and values) to associate with the email identity.

Returns:



331
332
333
 
# File 'ses/cfn_email_identity.rb', line 331

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



335
336
337
338
339
 
# File 'ses/cfn_email_identity.rb', line 335

def tags=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



344
345
346
 
# File 'ses/cfn_email_identity.rb', line 344

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

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


174
175
176
 
# File 'ses/cfn_email_identity.rb', line 174

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


184
185
186
 
# File 'ses/cfn_email_identity.rb', line 184

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


618
619
620
621
 
# File 'ses/cfn_email_identity.rb', line 618

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
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) 


357
358
359
360
361
362
 
# File 'ses/cfn_email_identity.rb', line 357

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