CfnConfigurationSetProps

class aws_cdk.aws_ses.CfnConfigurationSetProps(*, delivery_options=None, name=None, reputation_options=None, sending_options=None, suppression_options=None, tags=None, tracking_options=None, vdm_options=None)

Bases: object

Properties for defining a CfnConfigurationSet.

Parameters:

  • delivery_options (Union[IResolvable, DeliveryOptionsProperty, Dict[str, Any], None]) – Specifies the name of the dedicated IP pool to associate with the configuration set and whether messages that use the configuration set are required to use Transport Layer Security (TLS).

  • name (Optional[str]) – The name of the configuration set. The name must meet the following requirements:. - Contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). - Contain 64 characters or fewer.

  • reputation_options (Union[IResolvable, ReputationOptionsProperty, Dict[str, Any], None]) – An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set.

  • sending_options (Union[IResolvable, SendingOptionsProperty, Dict[str, Any], None]) – An object that defines whether or not Amazon SES can send email that you send using the configuration set.

  • suppression_options (Union[IResolvable, SuppressionOptionsProperty, Dict[str, Any], None]) – An object that contains information about the suppression list preferences for your account.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of objects that define the tags (keys and values) that are associated with the configuration set.

  • tracking_options (Union[IResolvable, TrackingOptionsProperty, Dict[str, Any], None]) – An object that defines the open and click tracking options for emails that you send using the configuration set.

  • vdm_options (Union[IResolvable, VdmOptionsProperty, Dict[str, Any], None]) – The Virtual Deliverability Manager (VDM) options that apply to the configuration set.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationset.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ses as ses

cfn_configuration_set_props = ses.CfnConfigurationSetProps(
    delivery_options=ses.CfnConfigurationSet.DeliveryOptionsProperty(
        max_delivery_seconds=123,
        sending_pool_name="sendingPoolName",
        tls_policy="tlsPolicy"
    ),
    name="name",
    reputation_options=ses.CfnConfigurationSet.ReputationOptionsProperty(
        reputation_metrics_enabled=False
    ),
    sending_options=ses.CfnConfigurationSet.SendingOptionsProperty(
        sending_enabled=False
    ),
    suppression_options=ses.CfnConfigurationSet.SuppressionOptionsProperty(
        suppressed_reasons=["suppressedReasons"]
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    tracking_options=ses.CfnConfigurationSet.TrackingOptionsProperty(
        custom_redirect_domain="customRedirectDomain",
        https_policy="httpsPolicy"
    ),
    vdm_options=ses.CfnConfigurationSet.VdmOptionsProperty(
        dashboard_options=ses.CfnConfigurationSet.DashboardOptionsProperty(
            engagement_metrics="engagementMetrics"
        ),
        guardian_options=ses.CfnConfigurationSet.GuardianOptionsProperty(
            optimized_shared_delivery="optimizedSharedDelivery"
        )
    )
)

Attributes

delivery_options

Specifies the name of the dedicated IP pool to associate with the configuration set and whether messages that use the configuration set are required to use Transport Layer Security (TLS).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationset.html#cfn-ses-configurationset-deliveryoptions

name

.

  • Contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

  • Contain 64 characters or fewer.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationset.html#cfn-ses-configurationset-name

Type:

The name of the configuration set. The name must meet the following requirements

reputation_options

An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationset.html#cfn-ses-configurationset-reputationoptions

sending_options

An object that defines whether or not Amazon SES can send email that you send using the configuration set.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationset.html#cfn-ses-configurationset-sendingoptions

suppression_options

An object that contains information about the suppression list preferences for your account.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationset.html#cfn-ses-configurationset-suppressionoptions

tags

An array of objects that define the tags (keys and values) that are associated with the configuration set.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationset.html#cfn-ses-configurationset-tags

tracking_options

An object that defines the open and click tracking options for emails that you send using the configuration set.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationset.html#cfn-ses-configurationset-trackingoptions

vdm_options

The Virtual Deliverability Manager (VDM) options that apply to the configuration set.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationset.html#cfn-ses-configurationset-vdmoptions