interface ConfigurationSetProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.SES.ConfigurationSetProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsses#ConfigurationSetProps |
![]() | software.amazon.awscdk.services.ses.ConfigurationSetProps |
![]() | aws_cdk.aws_ses.ConfigurationSetProps |
![]() | aws-cdk-lib » aws_ses » ConfigurationSetProps |
Properties for a configuration set.
Example
new ses.ConfigurationSet(this, 'ConfigurationSetWithVdmOptions', {
vdmOptions: {
engagementMetrics: true,
optimizedSharedDelivery: true,
},
});
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. |
disable | boolean | If true, account-level suppression list is disabled; |
max | Duration | The maximum amount of time that Amazon SES API v2 will attempt delivery of email. |
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). |
vdm | Vdm | The Virtual Deliverability Manager (VDM) options that apply to the configuration set. |
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.
disableSuppressionList?
Type:
boolean
(optional, default: false)
If true, account-level suppression list is disabled;
email sent with this configuration set will not use any suppression settings at all
maxDeliveryDuration?
Type:
Duration
(optional, default: undefined - SES defaults to 14 hours)
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.
reputationMetrics?
Type:
boolean
(optional, default: true)
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).
vdmOptions?
Type:
Vdm
(optional, 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.))
The Virtual Deliverability Manager (VDM) options that apply to the configuration set.