Class CfnIdentityProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnIdentityProps>
- Enclosing interface:
CfnIdentityProps
CfnIdentityProps
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.dkimSigningEnabled
(Boolean dkimSigningEnabled) Sets the value ofCfnIdentityProps.getDkimSigningEnabled()
dkimSigningEnabled
(IResolvable dkimSigningEnabled) Sets the value ofCfnIdentityProps.getDkimSigningEnabled()
feedbackForwardingEnabled
(Boolean feedbackForwardingEnabled) Sets the value ofCfnIdentityProps.getFeedbackForwardingEnabled()
feedbackForwardingEnabled
(IResolvable feedbackForwardingEnabled) Sets the value ofCfnIdentityProps.getFeedbackForwardingEnabled()
mailFromAttributes
(IResolvable mailFromAttributes) Sets the value ofCfnIdentityProps.getMailFromAttributes()
mailFromAttributes
(CfnIdentity.MailFromAttributesProperty mailFromAttributes) Sets the value ofCfnIdentityProps.getMailFromAttributes()
Sets the value ofCfnIdentityProps.getName()
tags
(List<? extends CfnIdentity.TagsProperty> tags) Sets the value ofCfnIdentityProps.getTags()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
name
Sets the value ofCfnIdentityProps.getName()
- Parameters:
name
- The address or domain of the identity, such as sender@example.com or example.co.uk . This parameter is required.- Returns:
this
-
dkimSigningEnabled
Sets the value ofCfnIdentityProps.getDkimSigningEnabled()
- Parameters:
dkimSigningEnabled
- For domain identities, this attribute is used to enable or disable DomainKeys Identified Mail (DKIM) signing for the domain. If the value istrue
, 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 theamazonses.com
domain. If the value isfalse
, then the messages that you send are only signed using the DKIM keys for theamazonses.com
domain.- Returns:
this
-
dkimSigningEnabled
@Stability(Stable) public CfnIdentityProps.Builder dkimSigningEnabled(IResolvable dkimSigningEnabled) Sets the value ofCfnIdentityProps.getDkimSigningEnabled()
- Parameters:
dkimSigningEnabled
- For domain identities, this attribute is used to enable or disable DomainKeys Identified Mail (DKIM) signing for the domain. If the value istrue
, 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 theamazonses.com
domain. If the value isfalse
, then the messages that you send are only signed using the DKIM keys for theamazonses.com
domain.- Returns:
this
-
feedbackForwardingEnabled
@Stability(Stable) public CfnIdentityProps.Builder feedbackForwardingEnabled(Boolean feedbackForwardingEnabled) Sets the value ofCfnIdentityProps.getFeedbackForwardingEnabled()
- Parameters:
feedbackForwardingEnabled
- 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:
this
-
feedbackForwardingEnabled
@Stability(Stable) public CfnIdentityProps.Builder feedbackForwardingEnabled(IResolvable feedbackForwardingEnabled) Sets the value ofCfnIdentityProps.getFeedbackForwardingEnabled()
- Parameters:
feedbackForwardingEnabled
- 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:
this
-
mailFromAttributes
@Stability(Stable) public CfnIdentityProps.Builder mailFromAttributes(IResolvable mailFromAttributes) Sets the value ofCfnIdentityProps.getMailFromAttributes()
- Parameters:
mailFromAttributes
- Used to enable or disable the custom Mail-From domain configuration for an email identity.- Returns:
this
-
mailFromAttributes
@Stability(Stable) public CfnIdentityProps.Builder mailFromAttributes(CfnIdentity.MailFromAttributesProperty mailFromAttributes) Sets the value ofCfnIdentityProps.getMailFromAttributes()
- Parameters:
mailFromAttributes
- Used to enable or disable the custom Mail-From domain configuration for an email identity.- Returns:
this
-
tags
@Stability(Stable) public CfnIdentityProps.Builder tags(List<? extends CfnIdentity.TagsProperty> tags) Sets the value ofCfnIdentityProps.getTags()
- Parameters:
tags
- An object that defines the tags (keys and values) that you want to associate with the email identity.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnIdentityProps>
- Returns:
- a new instance of
CfnIdentityProps
- Throws:
NullPointerException
- if any required attribute was not provided
-