Package software.amazon.awscdk.services.pinpointemail

Interface CfnIdentityProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIdentityProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-04-10T22:22:31.345Z")
@Stability(Stable)
public interface CfnIdentityProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnIdentity.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.pinpointemail.*;
 CfnIdentityProps cfnIdentityProps = CfnIdentityProps.builder()
         .name("name")
         // the properties below are optional
         .dkimSigningEnabled(false)
         .feedbackForwardingEnabled(false)
         .mailFromAttributes(MailFromAttributesProperty.builder()
                 .behaviorOnMxFailure("behaviorOnMxFailure")
                 .mailFromDomain("mailFromDomain")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnIdentityProps.Builder	A builder for CfnIdentityProps
static final class	CfnIdentityProps.Jsii$Proxy	An implementation for CfnIdentityProps

Method Summary

Modifier and Type	Method	Description
static CfnIdentityProps.Builder	builder()
default Object	getDkimSigningEnabled()	For domain identities, this attribute is used to enable or disable DomainKeys Identified Mail (DKIM) signing for the domain.
default Object	getFeedbackForwardingEnabled()	Used to enable or disable feedback forwarding for an identity.
default Object	getMailFromAttributes()	Used to enable or disable the custom Mail-From domain configuration for an email identity.
String	getName()	The address or domain of the identity, such as sender@example.com or example.co.uk .
default List<CfnTag>	getTags()	An object that defines the tags (keys and values) that you want to associate with the email identity.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

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

See Also:

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

getDkimSigningEnabled

@Stability(Stable)
@Nullable
default Object getDkimSigningEnabled()

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

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

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

getFeedbackForwardingEnabled

@Stability(Stable)
@Nullable
default Object getFeedbackForwardingEnabled()

Used to enable or disable feedback forwarding for an identity.

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

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

getMailFromAttributes

@Stability(Stable)
@Nullable
default Object getMailFromAttributes()

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

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

See Also:

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

builder

@Stability(Stable)
static CfnIdentityProps.Builder builder()

Returns:

a CfnIdentityProps.Builder of CfnIdentityProps