Package software.amazon.awscdk.mixins.preview.services.pinpointemail.mixins

Interface CfnIdentityMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIdentityMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:29.161Z")
@Stability(Stable)
public interface CfnIdentityMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnIdentityPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.mixins.preview.services.pinpointemail.mixins.*;
 CfnIdentityMixinProps cfnIdentityMixinProps = CfnIdentityMixinProps.builder()
         .dkimSigningEnabled(false)
         .feedbackForwardingEnabled(false)
         .mailFromAttributes(MailFromAttributesProperty.builder()
                 .behaviorOnMxFailure("behaviorOnMxFailure")
                 .mailFromDomain("mailFromDomain")
                 .build())
         .name("name")
         .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	CfnIdentityMixinProps.Builder	A builder for CfnIdentityMixinProps
static final class	CfnIdentityMixinProps.Jsii$Proxy	An implementation for CfnIdentityMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnIdentityMixinProps.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.
default 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

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.

Returns union: either Boolean or IResolvable

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

Returns union: either Boolean or IResolvable

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.

Returns union: either IResolvable or CfnIdentityPropsMixin.MailFromAttributesProperty

See Also:

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

getName

@Stability(Stable)
@Nullable
default 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

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 CfnIdentityMixinProps.Builder builder()

Returns:

a CfnIdentityMixinProps.Builder of CfnIdentityMixinProps