Class CfnIdentityProps

Properties for defining a CfnIdentity.

Inheritance

object

CfnIdentityProps

Implements

ICfnIdentityProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.PinpointEmail

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnIdentityProps : ICfnIdentityProps

Syntax (vb)

Public Class CfnIdentityProps Implements ICfnIdentityProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-identity.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.PinpointEmail;

             var cfnIdentityProps = 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

CfnIdentityProps()

Properties for defining a CfnIdentity.

Properties

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.

Constructors

CfnIdentityProps()

Properties for defining a CfnIdentity.

public CfnIdentityProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-identity.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.PinpointEmail;

             var cfnIdentityProps = 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"
                 } }
             };

Properties

DkimSigningEnabled

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

public object? DkimSigningEnabled { get; set; }

Property Value

object

Remarks

If the value is true , then the messages that you send from the domain are signed using both the DKIM keys for your domain, as well as the keys for the amazonses.com domain. If the value is false , then the messages that you send are only signed using the DKIM keys for the amazonses.com domain.

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

Type union: either bool or IResolvable

FeedbackForwardingEnabled

Used to enable or disable feedback forwarding for an identity.

public object? FeedbackForwardingEnabled { get; set; }

Property Value

object

Remarks

This setting determines what happens when an identity is used to send an email that results in a bounce or complaint event.

When you enable feedback forwarding, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email.

When you disable feedback forwarding, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).

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

Type union: either bool or IResolvable

MailFromAttributes

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

public object? MailFromAttributes { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnIdentity.IMailFromAttributesProperty

Name

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

public string Name { get; set; }