aws-cdk-lib.aws_ses.ConfigurationSetProps

interface ConfigurationSetProps

LanguageType name
.NETAmazon.CDK.AWS.SES.ConfigurationSetProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsses#ConfigurationSetProps
Javasoftware.amazon.awscdk.services.ses.ConfigurationSetProps
Pythonaws_cdk.aws_ses.ConfigurationSetProps
TypeScript (source)aws-cdk-lib » aws_ses » ConfigurationSetProps

Properties for a configuration set.

Example

declare const myPool: ses.IDedicatedIpPool;

new ses.ConfigurationSet(this, 'ConfigurationSet', {
  customTrackingRedirectDomain: 'track.cdk.dev',
  suppressionReasons: ses.SuppressionReasons.COMPLAINTS_ONLY,
  tlsPolicy: ses.ConfigurationSetTlsPolicy.REQUIRE,
  dedicatedIpPool: myPool,
});

Properties

NameTypeDescription
configurationSetName?stringA name for the configuration set.
customTrackingRedirectDomain?stringThe custom subdomain that is used to redirect email recipients to the Amazon SES event tracking domain.
dedicatedIpPool?IDedicatedIpPoolThe dedicated IP pool to associate with the configuration set.
reputationMetrics?booleanWhether to publish reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch.
sendingEnabled?booleanWhether email sending is enabled.
suppressionReasons?SuppressionReasonsThe reasons for which recipient email addresses should be automatically added to your account's suppression list.
tlsPolicy?ConfigurationSetTlsPolicySpecifies whether messages that use the configuration set are required to use Transport Layer Security (TLS).

configurationSetName?

Type: string (optional, default: a CloudFormation generated name)

A name for the configuration set.


customTrackingRedirectDomain?

Type: string (optional, default: use the default awstrack.me domain)

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


dedicatedIpPool?

Type: IDedicatedIpPool (optional, default: do not use a dedicated IP pool)

The dedicated IP pool to associate with the configuration set.


reputationMetrics?

Type: boolean (optional, default: false)

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


sendingEnabled?

Type: boolean (optional, default: true)

Whether email sending is enabled.


suppressionReasons?

Type: SuppressionReasons (optional, default: use account level settings)

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


tlsPolicy?

Type: ConfigurationSetTlsPolicy (optional, default: ConfigurationSetTlsPolicy.OPTIONAL)

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