Class CfnEmailIdentity

A CloudFormation AWS::SES::EmailIdentity.

Inheritance

System.Object

Construct

CfnElement

CfnRefElement

CfnResource

CfnEmailIdentity

Implements

IConstruct

Constructs.IConstruct

IDependable

IInspectable

Inherited Members

CfnResource.IsCfnResource(IConstruct)

CfnResource.AddDeletionOverride(String)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(String, Object)

CfnResource.AddOverride(String, Object)

CfnResource.AddPropertyDeletionOverride(String)

CfnResource.AddPropertyOverride(String, Object)

CfnResource.ApplyRemovalPolicy(Nullable<RemovalPolicy>, IRemovalPolicyOptions)

CfnResource.GetAtt(String)

CfnResource.GetMetadata(String)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(Object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnRefElement.Ref

CfnElement.IsCfnElement(Object)

CfnElement.OverrideLogicalId(String)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Construct.IsConstruct(Object)

Construct.OnPrepare()

Construct.OnSynthesize(ISynthesisSession)

Construct.OnValidate()

Construct.Prepare()

Construct.Synthesize(ISynthesisSession)

Construct.Validate()

Construct.Node

Namespace: Amazon.CDK.AWS.SES

Assembly: Amazon.CDK.AWS.SES.dll

Syntax (csharp)

public class CfnEmailIdentity : CfnResource, IConstruct, IDependable, IInspectable

Syntax (vb)

Public Class CfnEmailIdentity
    Inherits CfnResource
    Implements IConstruct, IDependable, IInspectable

Remarks

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.

CloudformationResource: AWS::SES::EmailIdentity

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-emailidentity.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.SES;

var cfnEmailIdentity = new CfnEmailIdentity(this, "MyCfnEmailIdentity", new CfnEmailIdentityProps {
    EmailIdentity = "emailIdentity",

    // the properties below are optional
    ConfigurationSetAttributes = new ConfigurationSetAttributesProperty {
        ConfigurationSetName = "configurationSetName"
    },
    DkimAttributes = new DkimAttributesProperty {
        SigningEnabled = false
    },
    DkimSigningAttributes = new DkimSigningAttributesProperty {
        DomainSigningPrivateKey = "domainSigningPrivateKey",
        DomainSigningSelector = "domainSigningSelector",
        NextSigningKeyLength = "nextSigningKeyLength"
    },
    FeedbackAttributes = new FeedbackAttributesProperty {
        EmailForwardingEnabled = false
    },
    MailFromAttributes = new MailFromAttributesProperty {
        BehaviorOnMxFailure = "behaviorOnMxFailure",
        MailFromDomain = "mailFromDomain"
    }
});

Synopsis

Constructors

CfnEmailIdentity(Construct, String, ICfnEmailIdentityProps)	Create a new `AWS::SES::EmailIdentity`.
CfnEmailIdentity(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnEmailIdentity(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps

Properties

AttrDkimDnsTokenName1	The host name for the first token that you have to add to the DNS configuration for your domain.
AttrDkimDnsTokenName2	The host name for the second token that you have to add to the DNS configuration for your domain.
AttrDkimDnsTokenName3	The host name for the third token that you have to add to the DNS configuration for your domain.
AttrDkimDnsTokenValue1	The record value for the first token that you have to add to the DNS configuration for your domain.
AttrDkimDnsTokenValue2	The record value for the second token that you have to add to the DNS configuration for your domain.
AttrDkimDnsTokenValue3	The record value for the third token that you have to add to the DNS configuration for your domain.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties
ConfigurationSetAttributes	Used to associate a configuration set with an email identity.
DkimAttributes	An object that contains information about the DKIM attributes for the identity.
DkimSigningAttributes	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 .
EmailIdentity	The email address or domain to verify.
FeedbackAttributes	Used to enable or disable feedback forwarding for an identity.
MailFromAttributes	Used to enable or disable the custom Mail-From domain configuration for an email identity.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnEmailIdentity(Construct, String, ICfnEmailIdentityProps)

Create a new AWS::SES::EmailIdentity.

public CfnEmailIdentity(Construct scope, string id, ICfnEmailIdentityProps props)

Parameters

scope Construct

scope in which this resource is defined.

id System.String

scoped id of the resource.

props ICfnEmailIdentityProps

resource properties.

CfnEmailIdentity(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnEmailIdentity(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue: The Javascript-owned object reference

CfnEmailIdentity(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnEmailIdentity(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps: The deputy props

Properties

AttrDkimDnsTokenName1

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

public virtual string AttrDkimDnsTokenName1 { get; }

Property Value

System.String

Remarks

CloudformationAttribute: DkimDNSTokenName1

AttrDkimDnsTokenName2

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

public virtual string AttrDkimDnsTokenName2 { get; }

Property Value

System.String

Remarks

CloudformationAttribute: DkimDNSTokenName2

AttrDkimDnsTokenName3

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

public virtual string AttrDkimDnsTokenName3 { get; }

Property Value

System.String

Remarks

CloudformationAttribute: DkimDNSTokenName3

AttrDkimDnsTokenValue1

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

public virtual string AttrDkimDnsTokenValue1 { get; }

Property Value

System.String

Remarks

CloudformationAttribute: DkimDNSTokenValue1

AttrDkimDnsTokenValue2

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

public virtual string AttrDkimDnsTokenValue2 { get; }

Property Value

System.String

Remarks

CloudformationAttribute: DkimDNSTokenValue2

AttrDkimDnsTokenValue3

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

public virtual string AttrDkimDnsTokenValue3 { get; }

Property Value

System.String

Remarks

CloudformationAttribute: DkimDNSTokenValue3

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

System.String

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

CfnResource.CfnProperties

ConfigurationSetAttributes

Used to associate a configuration set with an email identity.

public virtual object ConfigurationSetAttributes { get; set; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-emailidentity.html#cfn-ses-emailidentity-configurationsetattributes

DkimAttributes

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

public virtual object DkimAttributes { get; set; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-emailidentity.html#cfn-ses-emailidentity-dkimattributes

DkimSigningAttributes

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 .

public virtual object DkimSigningAttributes { get; set; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-emailidentity.html#cfn-ses-emailidentity-dkimsigningattributes

EmailIdentity

The email address or domain to verify.

public virtual string EmailIdentity { get; set; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-emailidentity.html#cfn-ses-emailidentity-emailidentity

FeedbackAttributes

Used to enable or disable feedback forwarding for an identity.

public virtual object FeedbackAttributes { get; set; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-emailidentity.html#cfn-ses-emailidentity-feedbackattributes

MailFromAttributes

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

public virtual object MailFromAttributes { get; set; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-emailidentity.html#cfn-ses-emailidentity-mailfromattributes

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props System.Collections.Generic.IDictionary<System.String, System.Object>

Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

CfnResource.RenderProperties(IDictionary<String, Object>)

Implements

IConstruct

Constructs.IConstruct

IDependable

IInspectable