ConfigurationSetProps

class aws_cdk.aws_ses.ConfigurationSetProps(*, configuration_set_name=None, custom_tracking_redirect_domain=None, dedicated_ip_pool=None, disable_suppression_list=None, max_delivery_duration=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 name

  • custom_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 domain

  • dedicated_ip_pool (Optional[IDedicatedIpPool]) – The dedicated IP pool to associate with the configuration set. Default: - do not use a dedicated IP pool

  • disable_suppression_list (Optional[bool]) – If true, account-level suppression list is disabled; email sent with this configuration set will not use any suppression settings at all Default: false

  • max_delivery_duration (Optional[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

  • reputation_metrics (Optional[bool]) – Whether to publish reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch. Default: true

  • sending_enabled (Optional[bool]) – Whether email sending is enabled. Default: true

  • suppression_reasons (Optional[SuppressionReasons]) – The reasons for which recipient email addresses should be automatically added to your account’s suppression list. Default: - use account level settings

  • tls_policy (Optional[ConfigurationSetTlsPolicy]) – Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). Default: ConfigurationSetTlsPolicy.OPTIONAL

  • vdm_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 the VdmAttributes Construct.)

ExampleMetadata:

infused

Example:

ses.ConfigurationSet(self, "ConfigurationSetWithVdmOptions",
    vdm_options=ses.VdmOptions(
        engagement_metrics=True,
        optimized_shared_delivery=True
    )
)

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

disable_suppression_list

If true, account-level suppression list is disabled;

email sent with this configuration set will not use any suppression settings at all

Default:

false

max_delivery_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

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