Class GuEmailIdentity

A construct to create an SES email identity. It also creates the required DNS records to verify the identity.

See

Example

new GuEmailIdentity(stack, "MyEmailIdentity", {
 domainName: "my-service.gutools.co.uk",
 app: "test",
});

Hierarchy

  • Mixin<typeof EmailIdentity, this> & EmailIdentity<this>
    • GuEmailIdentity

Constructors

constructor

Properties

dkimDnsTokenName1 dkimDnsTokenName2 dkimDnsTokenName3 dkimDnsTokenValue1 dkimDnsTokenValue2 dkimDnsTokenValue3 dkimRecords emailIdentityArn emailIdentityName env idWithApp node physicalName stack

Accessors

validDomains

Methods

_enableCrossEnvironment applyRemovalPolicy generatePhysicalName getResourceArnAttribute getResourceNameAttribute grant grantSendEmail toString fromEmailIdentityName isConstruct isOwnedResource isResource

Constructors

constructor

Properties

ReadonlydkimDnsTokenName1

dkimDnsTokenName1: string

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

Attribute

ReadonlydkimDnsTokenName2

dkimDnsTokenName2: string

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

Attribute

ReadonlydkimDnsTokenName3

dkimDnsTokenName3: string

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

Attribute

ReadonlydkimDnsTokenValue1

dkimDnsTokenValue1: string

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

Attribute

ReadonlydkimDnsTokenValue2

dkimDnsTokenValue2: string

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

Attribute

ReadonlydkimDnsTokenValue3

dkimDnsTokenValue3: string

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

Attribute

ReadonlydkimRecords

dkimRecords: DkimRecord[]

DKIM records for this identity

ReadonlyemailIdentityArn

emailIdentityArn: string

The ARN of the email identity

Attribute

ReadonlyemailIdentityName

emailIdentityName: string

The name of the email identity

Attribute

Readonlyenv

env: ResourceEnvironment

The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ReadonlyidWithApp

idWithApp: string

The ID of the construct with the App suffix. This should be used in place of id when trying to reference the construct.

Readonlynode

node: Node

The tree node.

Protected ReadonlyphysicalName

physicalName: 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.

Readonlystack

stack: Stack

The stack in which this resource is defined.

Accessors

StaticvalidDomains

Methods

_enableCrossEnvironment

  • _enableCrossEnvironment(): void
  • Internal

    Called when this resource is referenced across environments (account/region) to order to request that a physical name will be generated for this resource during synthesis, so the resource can be referenced through its absolute name/arn.

    Returns void

applyRemovalPolicy

  • applyRemovalPolicy(policy: RemovalPolicy): void

  • 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

    • policy: RemovalPolicy

    Returns void

ProtectedgeneratePhysicalName

  • generatePhysicalName(): string

  • Returns string

ProtectedgetResourceArnAttribute

  • getResourceArnAttribute(arnAttr: string, arnComponents: ArnComponents): 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 arnAttr, but if the resource is referenced across environments, arnComponents will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arnComponents.

    Parameters

    • arnAttr: string

      The CFN attribute which resolves to the ARN of the resource. Commonly it will be called "Arn" (e.g. resource.attrArn), but sometimes it's the CFN resource's ref.

    • arnComponents: ArnComponents

      The format of the ARN of this resource. You must reference this.physicalName somewhere within the ARN in order for cross-environment references to work.

    Returns string

ProtectedgetResourceNameAttribute

  • getResourceNameAttribute(nameAttr: string): 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 nameAttr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

    Parameters

    • nameAttr: string

      The CFN attribute which resolves to the resource's name. Commonly this is the resource's ref.

    Returns string

grant

  • grant(grantee: IGrantable, ...actions: string[]): Grant

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

    Parameters

    • grantee: IGrantable

      the principal (no-op if undefined)

    • ...actions: string[]

      the set of actions to allow

    Returns Grant

grantSendEmail

  • grantSendEmail(grantee: IGrantable): Grant

  • Permits an IAM principal the send email action.

    Actions: SendEmail, SendRawEmail.

    Parameters

    • grantee: IGrantable

      the principal to grant access to

    Returns Grant

toString

  • toString(): string

  • Returns a string representation of an object.

    Returns string

StaticfromEmailIdentityName

  • fromEmailIdentityName(
        scope: Construct,
        id: string,
        emailIdentityName: string,
    ): IEmailIdentity

  • Use an existing email identity

    Parameters

    • scope: Construct
    • id: string
    • emailIdentityName: string

    Returns IEmailIdentity

StaticisConstruct

  • isConstruct(x: any): x is Construct

  • Checks if x is a construct.

    Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

    Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

    Parameters

    • x: any

      Any object

    Returns x is Construct

    true if x is an object created from a class which extends Construct.

StaticisOwnedResource

  • isOwnedResource(construct: IConstruct): boolean

  • Returns true if the construct was created by CDK, and false otherwise

    Parameters

    • construct: IConstruct

    Returns boolean

StaticisResource

  • isResource(construct: IConstruct): construct is Resource

  • Check whether the given construct is a Resource

    Parameters

    • construct: IConstruct

    Returns construct is Resource

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods