interface ConfigurationSetProps
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.SES.ConfigurationSetProps |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awsses#ConfigurationSetProps |
Java | software.amazon.awscdk.services.ses.ConfigurationSetProps |
Python | aws_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
Name | Type | Description |
---|---|---|
configuration | string | A name for the configuration set. |
custom | string | The custom subdomain that is used to redirect email recipients to the Amazon SES event tracking domain. |
dedicated | IDedicated | The dedicated IP pool to associate with the configuration set. |
reputation | boolean | Whether to publish reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch. |
sending | boolean | Whether email sending is enabled. |
suppression | Suppression | The reasons for which recipient email addresses should be automatically added to your account's suppression list. |
tls | Configuration | Specifies 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:
IDedicated
(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:
Suppression
(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:
Configuration
(optional, default: ConfigurationSetTlsPolicy.OPTIONAL)
Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS).