Package software.amazon.awscdk.services.ses

Class ConfigurationSet.Builder

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

  • Method Details

    • create

      @Stability(Stable) public static ConfigurationSet.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of ConfigurationSet.Builder.

    • autoValidationThreshold

      @Stability(Stable) public ConfigurationSet.Builder autoValidationThreshold(AutoValidationThreshold autoValidationThreshold)
      The Auto Validation threshold for this configuration set.

      When set, Auto Validation is enabled for this configuration set with the specified confidence threshold. Cannot be combined with disableAutoValidation: true.

      Default: - inherit the account-level Auto Validation settings

      Parameters:
      autoValidationThreshold - The Auto Validation threshold for this configuration set. This parameter is required.
      Returns:
      this
      See Also:

    • configurationSetName

      @Stability(Stable) public ConfigurationSet.Builder configurationSetName(String configurationSetName)
      A name for the configuration set.

      Default: - a CloudFormation generated name

      Parameters:
      configurationSetName - A name for the configuration set. This parameter is required.
      Returns:
      this

    • customTrackingHttpsPolicy

      @Stability(Stable) public ConfigurationSet.Builder customTrackingHttpsPolicy(HttpsPolicy customTrackingHttpsPolicy)
      The https policy to use for tracking open and click events.

      Default: - HttpsPolicy.OPTIONAL if customTrackingRedirectDomain is set, otherwise undefined

      Parameters:
      customTrackingHttpsPolicy - The https policy to use for tracking open and click events. This parameter is required.
      Returns:
      this

    • customTrackingRedirectDomain

      @Stability(Stable) public ConfigurationSet.Builder customTrackingRedirectDomain(String customTrackingRedirectDomain)
      The custom subdomain that is used to redirect email recipients to the Amazon SES event tracking domain.

      Default: - use the default awstrack.me domain

      Parameters:
      customTrackingRedirectDomain - The custom subdomain that is used to redirect email recipients to the Amazon SES event tracking domain. This parameter is required.
      Returns:
      this

    • dedicatedIpPool

      @Stability(Stable) public ConfigurationSet.Builder dedicatedIpPool(IDedicatedIpPoolRef dedicatedIpPool)
      The dedicated IP pool to associate with the configuration set.

      Default: - do not use a dedicated IP pool

      Parameters:
      dedicatedIpPool - The dedicated IP pool to associate with the configuration set. This parameter is required.
      Returns:
      this

    • disableAutoValidation

      @Stability(Stable) public ConfigurationSet.Builder disableAutoValidation(Boolean disableAutoValidation)
      Override the account-level Auto Validation setting for this configuration set.

      • true: explicitly disable Auto Validation for this configuration set. Cannot be combined with autoValidationThreshold.
      • false: explicitly enable Auto Validation for this configuration set even if it is disabled at the account level. The threshold falls back to the SES default unless autoValidationThreshold is also specified.
      • undefined: inherit the account-level setting when autoValidationThreshold is also not specified.

      Default: - inherit the account-level Auto Validation settings when autoValidationThreshold is also unspecified

      Parameters:
      disableAutoValidation - Override the account-level Auto Validation setting for this configuration set. This parameter is required.
      Returns:
      this
      See Also:

    • disableSuppressionList

      @Stability(Stable) public ConfigurationSet.Builder disableSuppressionList(Boolean disableSuppressionList)
      If true, account-level suppression list is disabled;

      email sent with this configuration set will not use any suppression settings at all

      Default: false

      Parameters:
      disableSuppressionList - If true, account-level suppression list is disabled;. This parameter is required.
      Returns:
      this

    • maxDeliveryDuration

      @Stability(Stable) public ConfigurationSet.Builder maxDeliveryDuration(Duration maxDeliveryDuration)
      The maximum amount of time that Amazon SES API v2 will attempt delivery of email.

      This value must be greater than or equal to 5 minutes and less than or equal to 14 hours.

      Default: undefined - SES defaults to 14 hours

      Parameters:
      maxDeliveryDuration - The maximum amount of time that Amazon SES API v2 will attempt delivery of email. This parameter is required.
      Returns:
      this

    • reputationMetrics

      @Stability(Stable) public ConfigurationSet.Builder reputationMetrics(Boolean reputationMetrics)
      Whether to publish reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch.

      Default: true

      Parameters:
      reputationMetrics - Whether to publish reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch. This parameter is required.
      Returns:
      this

    • sendingEnabled

      @Stability(Stable) public ConfigurationSet.Builder sendingEnabled(Boolean sendingEnabled)
      Whether email sending is enabled.

      Default: true

      Parameters:
      sendingEnabled - Whether email sending is enabled. This parameter is required.
      Returns:
      this

    • suppressionReasons

      @Stability(Stable) public ConfigurationSet.Builder suppressionReasons(SuppressionReasons suppressionReasons)
      The reasons for which recipient email addresses should be automatically added to your account's suppression list.

      Default: - use account level settings

      Parameters:
      suppressionReasons - The reasons for which recipient email addresses should be automatically added to your account's suppression list. This parameter is required.
      Returns:
      this

    • tlsPolicy

      @Stability(Stable) public ConfigurationSet.Builder tlsPolicy(ConfigurationSetTlsPolicy tlsPolicy)
      Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS).

      Default: ConfigurationSetTlsPolicy.OPTIONAL

      Parameters:
      tlsPolicy - Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). This parameter is required.
      Returns:
      this

    • vdmOptions

      @Stability(Stable) public ConfigurationSet.Builder vdmOptions(VdmOptions vdmOptions)
      The Virtual Deliverability Manager (VDM) options that apply to the configuration set.

      Default: - VDM options not configured at the configuration set level. In this case, use account level settings. (To set the account level settings using CDK, use the `VdmAttributes` Construct.)

      Parameters:
      vdmOptions - The Virtual Deliverability Manager (VDM) options that apply to the configuration set. This parameter is required.
      Returns:
      this

    • build

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