AWS Fundamentals Logo
AWS Fundamentals
L2 Construct

ConfigurationSet

A configuration set.

Import

import { ConfigurationSet } from 'aws-cdk-lib/aws-ses';

Or use the module namespace:

import * as ses from 'aws-cdk-lib/aws-ses';
// ses.ConfigurationSet

Properties

Configuration passed to the constructor as ConfigurationSetProps.

configurationSetNameOptional
string

A name for the configuration set.

Default: - a CloudFormation generated name

customTrackingHttpsPolicyOptional
HttpsPolicy

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

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

customTrackingRedirectDomainOptional
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

dedicatedIpPoolOptional
IDedicatedIpPoolRef

The dedicated IP pool to associate with the configuration set.

Default: - do not use a dedicated IP pool

disableSuppressionListOptional
boolean

If true, account-level suppression list is disabled; email sent with this configuration set will not use any suppression settings at all

Default: false

maxDeliveryDurationOptional
Duration

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

reputationMetricsOptional
boolean

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

Default: true

sendingEnabledOptional
boolean

Whether email sending is enabled.

Default: true

suppressionReasonsOptional
SuppressionReasons

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

Default: - use account level settings

tlsPolicyOptional
ConfigurationSetTlsPolicy

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

Default: ConfigurationSetTlsPolicy.OPTIONAL

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

Get the Amazon SES Cheat Sheet

Everything you need to know about Amazon SES on one page. HD quality, print-friendly.

Download Free Infographic