Module: AWSCDK::SES::IEmailIdentity

Includes:
IResource, Interfaces::AWSSES::IEmailIdentityRef
Included in:
EmailIdentity
Defined in:
ses/i_email_identity.rb

Overview

An email identity.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'ses/i_email_identity.rb', line 114

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :email_identity_ref => { kind: :property, name: "emailIdentityRef", is_optional: false },
    :email_identity_arn => { kind: :property, name: "emailIdentityArn", is_optional: false },
    :email_identity_name => { kind: :property, name: "emailIdentityName", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :grant => { kind: :method, name: "grant", is_optional: false },
    :grant_send_email => { kind: :method, name: "grantSendEmail", is_optional: false },
  }
end

Instance Method Details

#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:



85
86
87
88
 
# File 'ses/i_email_identity.rb', line 85

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

#email_identity_arn ⇒ String

The ARN of the email identity.

Returns:

  • (String) 


48
49
50
 
# File 'ses/i_email_identity.rb', line 48

def email_identity_arn()
  jsii_get_property("emailIdentityArn")
end

#email_identity_name ⇒ String

The name of the email identity.

Returns:

  • (String) 


55
56
57
 
# File 'ses/i_email_identity.rb', line 55

def email_identity_name()
  jsii_get_property("emailIdentityName")
end

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

A reference to a EmailIdentity resource.

Returns:



41
42
43
 
# File 'ses/i_email_identity.rb', line 41

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:



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

def env()
  jsii_get_property("env")
end

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

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

Parameters:

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

    the principal (no-op if undefined).

  • actions (Array<String>) —

    the set of actions to allow.

Returns:



95
96
97
98
99
100
101
 
# File 'ses/i_email_identity.rb', line 95

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.

Parameters:

Returns:



109
110
111
112
 
# File 'ses/i_email_identity.rb', line 109

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) 


12
13
14
 
# File 'ses/i_email_identity.rb', line 12

def node()
  jsii_get_property("node")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



34
35
36
 
# File 'ses/i_email_identity.rb', line 34

def stack()
  jsii_get_property("stack")
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.

Parameters:

  • mixins (Array<Constructs::IMixin>) —

    The mixins to apply.

Returns:

  • (Constructs::IConstruct) —

    This construct for chaining



66
67
68
69
70
71
 
# File 'ses/i_email_identity.rb', line 66

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