Package software.amazon.awscdk.services.ses

Interface ConfigurationSetProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
ConfigurationSetProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.129.0 (build eaca441)", date="2026-05-13T16:55:18.069Z") @Stability(Stable) public interface ConfigurationSetProps extends software.amazon.jsii.JsiiSerializable
Properties for a configuration set.

Example: 

 ConfigurationSet.Builder.create(this, "ConfigurationSet")
         .customTrackingRedirectDomain("track.cdk.dev")
         .customTrackingHttpsPolicy(HttpsPolicy.REQUIRE)
         .build();

  • Method Details

    • getAutoValidationThreshold

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

      See Also:

    • getConfigurationSetName

      @Stability(Stable) @Nullable default String getConfigurationSetName()
      A name for the configuration set.

      Default: - a CloudFormation generated name

    • getCustomTrackingHttpsPolicy

      @Stability(Stable) @Nullable default HttpsPolicy getCustomTrackingHttpsPolicy()
      The https policy to use for tracking open and click events.

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

    • getCustomTrackingRedirectDomain

      @Stability(Stable) @Nullable default String getCustomTrackingRedirectDomain()
      The custom subdomain that is used to redirect email recipients to the Amazon SES event tracking domain.

      Default: - use the default awstrack.me domain

    • getDedicatedIpPool

      @Stability(Stable) @Nullable default IDedicatedIpPoolRef getDedicatedIpPool()
      The dedicated IP pool to associate with the configuration set.

      Default: - do not use a dedicated IP pool

    • getDisableAutoValidation

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

      See Also:

    • getDisableSuppressionList

      @Stability(Stable) @Nullable default Boolean getDisableSuppressionList()
      If true, account-level suppression list is disabled;

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

      Default: false

    • getMaxDeliveryDuration

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

    • getReputationMetrics

      @Stability(Stable) @Nullable default Boolean getReputationMetrics()
      Whether to publish reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch.

      Default: true

    • getSendingEnabled

      @Stability(Stable) @Nullable default Boolean getSendingEnabled()
      Whether email sending is enabled.

      Default: true

    • getSuppressionReasons

      @Stability(Stable) @Nullable default SuppressionReasons getSuppressionReasons()
      The reasons for which recipient email addresses should be automatically added to your account's suppression list.

      Default: - use account level settings

    • getTlsPolicy

      @Stability(Stable) @Nullable default ConfigurationSetTlsPolicy getTlsPolicy()
      Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS).

      Default: ConfigurationSetTlsPolicy.OPTIONAL

    • getVdmOptions

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

    • builder

      @Stability(Stable) static ConfigurationSetProps.Builder builder()
      Returns:
      a ConfigurationSetProps.Builder of ConfigurationSetProps