ConfigurationSetProps
- class aws_cdk.aws_ses.ConfigurationSetProps(*, configuration_set_name=None, custom_tracking_redirect_domain=None, dedicated_ip_pool=None, reputation_metrics=None, sending_enabled=None, suppression_reasons=None, tls_policy=None, vdm_options=None)
Bases:
object
Properties for a configuration set.
- Parameters:
configuration_set_name (
Optional
[str
]) – A name for the configuration set. Default: - a CloudFormation generated namecustom_tracking_redirect_domain (
Optional
[str
]) – The custom subdomain that is used to redirect email recipients to the Amazon SES event tracking domain. Default: - use the default awstrack.me domaindedicated_ip_pool (
Optional
[IDedicatedIpPool
]) – The dedicated IP pool to associate with the configuration set. Default: - do not use a dedicated IP poolreputation_metrics (
Optional
[bool
]) – Whether to publish reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch. Default: truesending_enabled (
Optional
[bool
]) – Whether email sending is enabled. Default: truesuppression_reasons (
Optional
[SuppressionReasons
]) – The reasons for which recipient email addresses should be automatically added to your account’s suppression list. Default: - use account level settingstls_policy (
Optional
[ConfigurationSetTlsPolicy
]) – Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). Default: ConfigurationSetTlsPolicy.OPTIONALvdm_options (
Union
[VdmOptions
,Dict
[str
,Any
],None
]) – 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 theVdmAttributes
Construct.)
- ExampleMetadata:
infused
Example:
# my_pool: ses.IDedicatedIpPool ses.ConfigurationSet(self, "ConfigurationSet", custom_tracking_redirect_domain="track.cdk.dev", suppression_reasons=ses.SuppressionReasons.COMPLAINTS_ONLY, tls_policy=ses.ConfigurationSetTlsPolicy.REQUIRE, dedicated_ip_pool=my_pool )
Attributes
- configuration_set_name
A name for the configuration set.
- Default:
a CloudFormation generated name
- custom_tracking_redirect_domain
The custom subdomain that is used to redirect email recipients to the Amazon SES event tracking domain.
- Default:
use the default awstrack.me domain
- dedicated_ip_pool
The dedicated IP pool to associate with the configuration set.
- Default:
do not use a dedicated IP pool
- reputation_metrics
Whether to publish reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch.
- Default:
true
- sending_enabled
Whether email sending is enabled.
- Default:
true
- suppression_reasons
The reasons for which recipient email addresses should be automatically added to your account’s suppression list.
- Default:
use account level settings
- tls_policy
Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS).
- Default:
ConfigurationSetTlsPolicy.OPTIONAL
- vdm_options
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.)