Class CfnIdentity

Specifies an identity to use for sending email through Amazon Pinpoint.

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnIdentity
Inherited Members
Namespace: Amazon.CDK.AWS.PinpointEmail
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnIdentity : CfnResource, IInspectable, ITaggableV2
Syntax (vb)
Public Class CfnIdentity Inherits CfnResource Implements IInspectable, ITaggableV2
Remarks

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

When you verify an email address, Amazon Pinpoint 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, this operation provides a set of DKIM tokens, which you can convert into CNAME tokens. You add these CNAME tokens to the DNS configuration for your domain. Your domain is verified when Amazon Pinpoint detects these records in the DNS configuration for your domain. It usually takes around 72 hours to complete the domain verification process.

When you use CloudFormation to specify an identity, CloudFormation might indicate that the identity was created successfully. However, you have to verify the identity before you can use it to send email.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-identity.html

CloudformationResource: AWS::PinpointEmail::Identity

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.PinpointEmail;

             var cfnIdentity = new CfnIdentity(this, "MyCfnIdentity", new CfnIdentityProps {
                 Name = "name",

                 // the properties below are optional
                 DkimSigningEnabled = false,
                 FeedbackForwardingEnabled = false,
                 MailFromAttributes = new MailFromAttributesProperty {
                     BehaviorOnMxFailure = "behaviorOnMxFailure",
                     MailFromDomain = "mailFromDomain"
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnIdentity(Construct, string, ICfnIdentityProps)

Specifies an identity to use for sending email through Amazon Pinpoint.

Properties

AttrId

Specifies an identity to use for sending email through Amazon Pinpoint.
AttrIdentityDnsRecordName1

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

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

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

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

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

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.
CdkTagManager

Tag Manager which manages the tags for this resource.
CfnProperties

Specifies an identity to use for sending email through Amazon Pinpoint.
DkimSigningEnabled

For domain identities, this attribute is used to enable or disable DomainKeys Identified Mail (DKIM) signing for the domain.
FeedbackForwardingEnabled

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.
Name

The address or domain of the identity, such as *sender@example.com* or example.co.uk .
Tags

An object that defines the tags (keys and values) that you want to associate with the email identity.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)

Specifies an identity to use for sending email through Amazon Pinpoint.

Constructors

CfnIdentity(Construct, string, ICfnIdentityProps)

Specifies an identity to use for sending email through Amazon Pinpoint.

public CfnIdentity(Construct scope, string id, ICfnIdentityProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

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

props ICfnIdentityProps

Resource properties.

Remarks

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

When you verify an email address, Amazon Pinpoint 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, this operation provides a set of DKIM tokens, which you can convert into CNAME tokens. You add these CNAME tokens to the DNS configuration for your domain. Your domain is verified when Amazon Pinpoint detects these records in the DNS configuration for your domain. It usually takes around 72 hours to complete the domain verification process.

When you use CloudFormation to specify an identity, CloudFormation might indicate that the identity was created successfully. However, you have to verify the identity before you can use it to send email.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-identity.html

CloudformationResource: AWS::PinpointEmail::Identity

ExampleMetadata: fixture=_generated

Properties

AttrId

Specifies an identity to use for sending email through Amazon Pinpoint.

public virtual string AttrId { get; }
Property Value

string

Remarks

CloudformationAttribute: Id

AttrIdentityDnsRecordName1

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

public virtual string AttrIdentityDnsRecordName1 { get; }
Property Value

string

Remarks

For more information, see Verifying a Domain in the Amazon Pinpoint User Guide.

CloudformationAttribute: IdentityDNSRecordName1

AttrIdentityDnsRecordName2

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

public virtual string AttrIdentityDnsRecordName2 { get; }
Property Value

string

Remarks

CloudformationAttribute: IdentityDNSRecordName2

AttrIdentityDnsRecordName3

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

public virtual string AttrIdentityDnsRecordName3 { get; }
Property Value

string

Remarks

CloudformationAttribute: IdentityDNSRecordName3

AttrIdentityDnsRecordValue1

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

public virtual string AttrIdentityDnsRecordValue1 { get; }
Property Value

string

Remarks

CloudformationAttribute: IdentityDNSRecordValue1

AttrIdentityDnsRecordValue2

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

public virtual string AttrIdentityDnsRecordValue2 { get; }
Property Value

string

Remarks

CloudformationAttribute: IdentityDNSRecordValue2

AttrIdentityDnsRecordValue3

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

public virtual string AttrIdentityDnsRecordValue3 { get; }
Property Value

string

Remarks

CloudformationAttribute: IdentityDNSRecordValue3

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

string

Remarks

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

When you verify an email address, Amazon Pinpoint 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, this operation provides a set of DKIM tokens, which you can convert into CNAME tokens. You add these CNAME tokens to the DNS configuration for your domain. Your domain is verified when Amazon Pinpoint detects these records in the DNS configuration for your domain. It usually takes around 72 hours to complete the domain verification process.

When you use CloudFormation to specify an identity, CloudFormation might indicate that the identity was created successfully. However, you have to verify the identity before you can use it to send email.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-identity.html

CloudformationResource: AWS::PinpointEmail::Identity

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }
Property Value

TagManager

Remarks

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

When you verify an email address, Amazon Pinpoint 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, this operation provides a set of DKIM tokens, which you can convert into CNAME tokens. You add these CNAME tokens to the DNS configuration for your domain. Your domain is verified when Amazon Pinpoint detects these records in the DNS configuration for your domain. It usually takes around 72 hours to complete the domain verification process.

When you use CloudFormation to specify an identity, CloudFormation might indicate that the identity was created successfully. However, you have to verify the identity before you can use it to send email.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-identity.html

CloudformationResource: AWS::PinpointEmail::Identity

ExampleMetadata: fixture=_generated

CfnProperties

Specifies an identity to use for sending email through Amazon Pinpoint.

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

IDictionary<string, object>

Overrides
Remarks

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

When you verify an email address, Amazon Pinpoint 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, this operation provides a set of DKIM tokens, which you can convert into CNAME tokens. You add these CNAME tokens to the DNS configuration for your domain. Your domain is verified when Amazon Pinpoint detects these records in the DNS configuration for your domain. It usually takes around 72 hours to complete the domain verification process.

When you use CloudFormation to specify an identity, CloudFormation might indicate that the identity was created successfully. However, you have to verify the identity before you can use it to send email.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-identity.html

CloudformationResource: AWS::PinpointEmail::Identity

ExampleMetadata: fixture=_generated

DkimSigningEnabled

For domain identities, this attribute is used to enable or disable DomainKeys Identified Mail (DKIM) signing for the domain.

public virtual object? DkimSigningEnabled { get; set; }
Property Value

object

Remarks

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

When you verify an email address, Amazon Pinpoint 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, this operation provides a set of DKIM tokens, which you can convert into CNAME tokens. You add these CNAME tokens to the DNS configuration for your domain. Your domain is verified when Amazon Pinpoint detects these records in the DNS configuration for your domain. It usually takes around 72 hours to complete the domain verification process.

When you use CloudFormation to specify an identity, CloudFormation might indicate that the identity was created successfully. However, you have to verify the identity before you can use it to send email.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-identity.html

CloudformationResource: AWS::PinpointEmail::Identity

ExampleMetadata: fixture=_generated

FeedbackForwardingEnabled

Used to enable or disable feedback forwarding for an identity.

public virtual object? FeedbackForwardingEnabled { get; set; }
Property Value

object

Remarks

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

When you verify an email address, Amazon Pinpoint 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, this operation provides a set of DKIM tokens, which you can convert into CNAME tokens. You add these CNAME tokens to the DNS configuration for your domain. Your domain is verified when Amazon Pinpoint detects these records in the DNS configuration for your domain. It usually takes around 72 hours to complete the domain verification process.

When you use CloudFormation to specify an identity, CloudFormation might indicate that the identity was created successfully. However, you have to verify the identity before you can use it to send email.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-identity.html

CloudformationResource: AWS::PinpointEmail::Identity

ExampleMetadata: fixture=_generated

MailFromAttributes

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

public virtual object? MailFromAttributes { get; set; }
Property Value

object

Remarks

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

When you verify an email address, Amazon Pinpoint 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, this operation provides a set of DKIM tokens, which you can convert into CNAME tokens. You add these CNAME tokens to the DNS configuration for your domain. Your domain is verified when Amazon Pinpoint detects these records in the DNS configuration for your domain. It usually takes around 72 hours to complete the domain verification process.

When you use CloudFormation to specify an identity, CloudFormation might indicate that the identity was created successfully. However, you have to verify the identity before you can use it to send email.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-identity.html

CloudformationResource: AWS::PinpointEmail::Identity

ExampleMetadata: fixture=_generated

Name

The address or domain of the identity, such as *sender@example.com* or example.co.uk .

public virtual string Name { get; set; }
Property Value

string

Remarks

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

When you verify an email address, Amazon Pinpoint 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, this operation provides a set of DKIM tokens, which you can convert into CNAME tokens. You add these CNAME tokens to the DNS configuration for your domain. Your domain is verified when Amazon Pinpoint detects these records in the DNS configuration for your domain. It usually takes around 72 hours to complete the domain verification process.

When you use CloudFormation to specify an identity, CloudFormation might indicate that the identity was created successfully. However, you have to verify the identity before you can use it to send email.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-identity.html

CloudformationResource: AWS::PinpointEmail::Identity

ExampleMetadata: fixture=_generated

Tags

An object that defines the tags (keys and values) that you want to associate with the email identity.

public virtual ICfnTag[]? Tags { get; set; }
Property Value

ICfnTag[]

Remarks

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

When you verify an email address, Amazon Pinpoint 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, this operation provides a set of DKIM tokens, which you can convert into CNAME tokens. You add these CNAME tokens to the DNS configuration for your domain. Your domain is verified when Amazon Pinpoint detects these records in the DNS configuration for your domain. It usually takes around 72 hours to complete the domain verification process.

When you use CloudFormation to specify an identity, CloudFormation might indicate that the identity was created successfully. However, you have to verify the identity before you can use it to send email.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-identity.html

CloudformationResource: AWS::PinpointEmail::Identity

ExampleMetadata: fixture=_generated

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.

Remarks

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

When you verify an email address, Amazon Pinpoint 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, this operation provides a set of DKIM tokens, which you can convert into CNAME tokens. You add these CNAME tokens to the DNS configuration for your domain. Your domain is verified when Amazon Pinpoint detects these records in the DNS configuration for your domain. It usually takes around 72 hours to complete the domain verification process.

When you use CloudFormation to specify an identity, CloudFormation might indicate that the identity was created successfully. However, you have to verify the identity before you can use it to send email.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-identity.html

CloudformationResource: AWS::PinpointEmail::Identity

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Specifies an identity to use for sending email through Amazon Pinpoint.

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

IDictionary<string, object>

Overrides
Remarks

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

When you verify an email address, Amazon Pinpoint 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, this operation provides a set of DKIM tokens, which you can convert into CNAME tokens. You add these CNAME tokens to the DNS configuration for your domain. Your domain is verified when Amazon Pinpoint detects these records in the DNS configuration for your domain. It usually takes around 72 hours to complete the domain verification process.

When you use CloudFormation to specify an identity, CloudFormation might indicate that the identity was created successfully. However, you have to verify the identity before you can use it to send email.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-identity.html

CloudformationResource: AWS::PinpointEmail::Identity

ExampleMetadata: fixture=_generated

Implements