aws-cdk-lib.aws_ses.ConfigurationSetProps

ConfigurationSetProps Struct

Properties for a configuration set.

ConfigurationSetProps

used as props by

• ConfigurationSet

Source

aws-ses/lib/configuration-set.ts

Type last changed

v2.254.0 · 13 May 2026

Example

new ses.ConfigurationSet(this, 'ConfigurationSet', {
  customTrackingRedirectDomain: 'track.cdk.dev',
  customTrackingHttpsPolicy: ses.HttpsPolicy.REQUIRE,
});

Properties

autoValidationThreshold?optionalAutoValidationThresholdauto_validation_threshold?optionalAutoValidationThresholdautoValidationThreshold?optionalAutoValidationThresholdAutoValidationThreshold?optionalAutoValidationThresholdAutoValidationThreshold?optionalAutoValidationThreshold#

The Auto Validation threshold for this configuration set.

Default: inherit the account-level Auto Validation settings

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

configurationSetName?optionalstringconfiguration_set_name?optionalstrconfigurationSetName?optionalStringConfigurationSetName?optionalstringConfigurationSetName?optional*string#

A name for the configuration set.

Default: a CloudFormation generated name

customTrackingHttpsPolicy?optionalHttpsPolicycustom_tracking_https_policy?optionalHttpsPolicycustomTrackingHttpsPolicy?optionalHttpsPolicyCustomTrackingHttpsPolicy?optionalHttpsPolicyCustomTrackingHttpsPolicy?optionalHttpsPolicy#

The https policy to use for tracking open and click events.

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

customTrackingRedirectDomain?optionalstringcustom_tracking_redirect_domain?optionalstrcustomTrackingRedirectDomain?optionalStringCustomTrackingRedirectDomain?optionalstringCustomTrackingRedirectDomain?optional*string#

The custom subdomain that is used to redirect email recipients to the Amazon SES event tracking domain.

Default: use the default awstrack.me domain

dedicatedIpPool?optionalIDedicatedIpPoolRefdedicated_ip_pool?optionalIDedicatedIpPoolRefdedicatedIpPool?optionalIDedicatedIpPoolRefDedicatedIpPool?optionalIDedicatedIpPoolRefDedicatedIpPool?optionalIDedicatedIpPoolRef#

The dedicated IP pool to associate with the configuration set.

Default: do not use a dedicated IP pool

disableAutoValidation?optionalbooleandisable_auto_validation?optionalbooldisableAutoValidation?optionalBooleanDisableAutoValidation?optionalboolDisableAutoValidation?optional*bool#

Override the account-level Auto Validation setting for this configuration set.

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

notes

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

disableSuppressionList?optionalbooleandisable_suppression_list?optionalbooldisableSuppressionList?optionalBooleanDisableSuppressionList?optionalboolDisableSuppressionList?optional*bool= false#

If true, account-level suppression list is disabled;

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

maxDeliveryDuration?optionalDurationmax_delivery_duration?optionalDurationmaxDeliveryDuration?optionalDurationMaxDeliveryDuration?optionalDurationMaxDeliveryDuration?optionalDuration#

The maximum amount of time that Amazon SES API v2 will attempt delivery of email.

Default: undefined - SES defaults to 14 hours

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

reputationMetrics?optionalbooleanreputation_metrics?optionalboolreputationMetrics?optionalBooleanReputationMetrics?optionalboolReputationMetrics?optional*bool= true#

Whether to publish reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch.

sendingEnabled?optionalbooleansending_enabled?optionalboolsendingEnabled?optionalBooleanSendingEnabled?optionalboolSendingEnabled?optional*bool= true#

Whether email sending is enabled.

suppressionReasons?optionalSuppressionReasonssuppression_reasons?optionalSuppressionReasonssuppressionReasons?optionalSuppressionReasonsSuppressionReasons?optionalSuppressionReasonsSuppressionReasons?optionalSuppressionReasons#

The reasons for which recipient email addresses should be automatically added to your account's suppression list.

Default: use account level settings

tlsPolicy?optionalConfigurationSetTlsPolicytls_policy?optionalConfigurationSetTlsPolicytlsPolicy?optionalConfigurationSetTlsPolicyTlsPolicy?optionalConfigurationSetTlsPolicyTlsPolicy?optionalConfigurationSetTlsPolicy#

Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS).

Default: ConfigurationSetTlsPolicy.OPTIONAL

vdmOptions?optionalVdmOptionsvdm_options?optionalVdmOptionsvdmOptions?optionalVdmOptionsVdmOptions?optionalVdmOptionsVdmOptions?optionalVdmOptions#

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