Package software.amazon.awscdk.services.pinpointemail

Class CfnIdentity.Builder

java.lang.Object
software.amazon.awscdk.services.pinpointemail.CfnIdentity.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnIdentity>
Enclosing class:
CfnIdentity
@Stability(Stable) public static final class CfnIdentity.Builder extends Object implements software.amazon.jsii.Builder<CfnIdentity>
A fluent builder for CfnIdentity.

  • Method Details

    • create

      @Stability(Stable) public static CfnIdentity.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnIdentity.Builder.

    • name

      @Stability(Stable) public CfnIdentity.Builder name(String name)
      The address or domain of the identity, such as sender@example.com or example.co.uk .

      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

      @Stability(Stable) public CfnIdentity.Builder dkimSigningEnabled(Boolean dkimSigningEnabled)
      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.

      Parameters:
      dkimSigningEnabled - For domain identities, this attribute is used to enable or disable DomainKeys Identified Mail (DKIM) signing for the domain. This parameter is required.
      Returns:
      this

    • dkimSigningEnabled

      @Stability(Stable) public CfnIdentity.Builder dkimSigningEnabled(IResolvable dkimSigningEnabled)
      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.

      Parameters:
      dkimSigningEnabled - For domain identities, this attribute is used to enable or disable DomainKeys Identified Mail (DKIM) signing for the domain. This parameter is required.
      Returns:
      this

    • feedbackForwardingEnabled

      @Stability(Stable) public CfnIdentity.Builder feedbackForwardingEnabled(Boolean 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).

      Parameters:
      feedbackForwardingEnabled - Used to enable or disable feedback forwarding for an identity. This parameter is required.
      Returns:
      this

    • feedbackForwardingEnabled

      @Stability(Stable) public CfnIdentity.Builder feedbackForwardingEnabled(IResolvable 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).

      Parameters:
      feedbackForwardingEnabled - Used to enable or disable feedback forwarding for an identity. This parameter is required.
      Returns:
      this

    • mailFromAttributes

      @Stability(Stable) public CfnIdentity.Builder mailFromAttributes(IResolvable mailFromAttributes)
      Used to enable or disable the custom Mail-From domain configuration for an email identity.

      Parameters:
      mailFromAttributes - Used to enable or disable the custom Mail-From domain configuration for an email identity. This parameter is required.
      Returns:
      this

    • mailFromAttributes

      @Stability(Stable) public CfnIdentity.Builder mailFromAttributes(CfnIdentity.MailFromAttributesProperty mailFromAttributes)
      Used to enable or disable the custom Mail-From domain configuration for an email identity.

      Parameters:
      mailFromAttributes - Used to enable or disable the custom Mail-From domain configuration for an email identity. This parameter is required.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnIdentity.Builder tags(List<? extends CfnIdentity.TagsProperty> tags)
      An object that defines the tags (keys and values) that you want to associate with the email identity.

      Parameters:
      tags - An object that defines the tags (keys and values) that you want to associate with the email identity. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public CfnIdentity build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnIdentity>
      Returns:
      a newly built instance of CfnIdentity.