CfnConfigurationSetPropsMixin

class aws_cdk.mixins_preview.aws_ses.mixins.CfnConfigurationSetPropsMixin(props, *, strategy=None)

Bases: Mixin

Configuration sets let you create groups of rules that you can apply to the emails you send using Amazon SES.

For more information about using configuration sets, see Using Amazon SES Configuration Sets in the Amazon SES Developer Guide . .. epigraph:

*Required permissions:*

To apply any of the resource options, you will need to have the corresponding AWS Identity and Access Management (IAM) SES API v2 permissions:

- ``ses:GetConfigurationSet``
- (This permission is replacing the v1 *ses:DescribeConfigurationSet* permission which will not work with these v2 resource options.)
- ``ses:PutConfigurationSetDeliveryOptions``
- ``ses:PutConfigurationSetReputationOptions``
- ``ses:PutConfigurationSetSendingOptions``
- ``ses:PutConfigurationSetSuppressionOptions``
- ``ses:PutConfigurationSetTrackingOptions``

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationset.html
CloudformationResource:: AWS::SES::ConfigurationSet
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_ses import mixins as ses_mixins

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

Create a mixin to apply properties to AWS::SES::ConfigurationSet.

Parameters:

props (Union[CfnConfigurationSetMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['deliveryOptions', 'name', 'reputationOptions', 'sendingOptions', 'suppressionOptions', 'tags', 'trackingOptions', 'vdmOptions']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

DashboardOptionsProperty

class CfnConfigurationSetPropsMixin.DashboardOptionsProperty(*, engagement_metrics=None)

Bases: object

An object containing additional settings for your VDM configuration as applicable to the Dashboard.

Parameters:: engagement_metrics (Optional[str]) – Specifies the status of your VDM engagement metrics collection. Can be one of the following:. - ENABLED – Amazon SES enables engagement metrics for the configuration set. - DISABLED – Amazon SES disables engagement metrics for the configuration set.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-dashboardoptions.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.mixins_preview.aws_ses import mixins as ses_mixins

dashboard_options_property = ses_mixins.CfnConfigurationSetPropsMixin.DashboardOptionsProperty(
    engagement_metrics="engagementMetrics"
)

Attributes

engagement_metrics

.

ENABLED – Amazon SES enables engagement metrics for the configuration set.
DISABLED – Amazon SES disables engagement metrics for the configuration set.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-dashboardoptions.html#cfn-ses-configurationset-dashboardoptions-engagementmetrics
Type:: Specifies the status of your VDM engagement metrics collection. Can be one of the following

DeliveryOptionsProperty

class CfnConfigurationSetPropsMixin.DeliveryOptionsProperty(*, max_delivery_seconds=None, sending_pool_name=None, tls_policy=None)

Bases: object

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

Parameters:

max_delivery_seconds (Union[int, float, None]) – The name of the configuration set used when sent through a configuration set with archiving enabled.
sending_pool_name (Optional[str]) – The name of the dedicated IP pool to associate with the configuration set.
tls_policy (Optional[str]) – Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is REQUIRE , messages are only delivered if a TLS connection can be established. If the value is OPTIONAL , messages can be delivered in plain text if a TLS connection can’t be established. Valid Values: REQUIRE | OPTIONAL

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-deliveryoptions.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.mixins_preview.aws_ses import mixins as ses_mixins

delivery_options_property = ses_mixins.CfnConfigurationSetPropsMixin.DeliveryOptionsProperty(
    max_delivery_seconds=123,
    sending_pool_name="sendingPoolName",
    tls_policy="tlsPolicy"
)

Attributes

max_delivery_seconds

The name of the configuration set used when sent through a configuration set with archiving enabled.

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

sending_pool_name

The name of the dedicated IP pool to associate with the configuration set.

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

tls_policy

Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS).

If the value is REQUIRE , messages are only delivered if a TLS connection can be established. If the value is OPTIONAL , messages can be delivered in plain text if a TLS connection can’t be established.

Valid Values: REQUIRE | OPTIONAL

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

GuardianOptionsProperty

class CfnConfigurationSetPropsMixin.GuardianOptionsProperty(*, optimized_shared_delivery=None)

Bases: object

An object containing additional settings for your VDM configuration as applicable to the Guardian.

Parameters:: optimized_shared_delivery (Optional[str]) – Specifies the status of your VDM optimized shared delivery. Can be one of the following:. - ENABLED – Amazon SES enables optimized shared delivery for the configuration set. - DISABLED – Amazon SES disables optimized shared delivery for the configuration set.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-guardianoptions.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.mixins_preview.aws_ses import mixins as ses_mixins

guardian_options_property = ses_mixins.CfnConfigurationSetPropsMixin.GuardianOptionsProperty(
    optimized_shared_delivery="optimizedSharedDelivery"
)

Attributes

optimized_shared_delivery

.

ENABLED – Amazon SES enables optimized shared delivery for the configuration set.
DISABLED – Amazon SES disables optimized shared delivery for the configuration set.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-guardianoptions.html#cfn-ses-configurationset-guardianoptions-optimizedshareddelivery
Type:: Specifies the status of your VDM optimized shared delivery. Can be one of the following

ReputationOptionsProperty

class CfnConfigurationSetPropsMixin.ReputationOptionsProperty(*, reputation_metrics_enabled=None)

Bases: object

Enable or disable collection of reputation metrics for emails that you send using this configuration set in the current AWS Region.

Parameters:: reputation_metrics_enabled (Union[bool, IResolvable, None]) – If true , tracking of reputation metrics is enabled for the configuration set. If false , tracking of reputation metrics is disabled for the configuration set.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-reputationoptions.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.mixins_preview.aws_ses import mixins as ses_mixins

reputation_options_property = ses_mixins.CfnConfigurationSetPropsMixin.ReputationOptionsProperty(
    reputation_metrics_enabled=False
)

Attributes

reputation_metrics_enabled

If true , tracking of reputation metrics is enabled for the configuration set.

If false , tracking of reputation metrics is disabled for the configuration set.

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

SendingOptionsProperty

class CfnConfigurationSetPropsMixin.SendingOptionsProperty(*, sending_enabled=None)

Bases: object

Used to enable or disable email sending for messages that use this configuration set in the current AWS Region.

Parameters:: sending_enabled (Union[bool, IResolvable, None]) – If true , email sending is enabled for the configuration set. If false , email sending is disabled for the configuration set.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-sendingoptions.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.mixins_preview.aws_ses import mixins as ses_mixins

sending_options_property = ses_mixins.CfnConfigurationSetPropsMixin.SendingOptionsProperty(
    sending_enabled=False
)

Attributes

sending_enabled

If true , email sending is enabled for the configuration set.

If false , email sending is disabled for the configuration set.

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

SuppressionOptionsProperty

class CfnConfigurationSetPropsMixin.SuppressionOptionsProperty(*, suppressed_reasons=None)

Bases: object

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

Parameters:: suppressed_reasons (Optional[Sequence[str]]) – A list that contains the reasons that email addresses are automatically added to the suppression list for your account. This list can contain any or all of the following: - COMPLAINT – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a complaint. - BOUNCE – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a hard bounce.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-suppressionoptions.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.mixins_preview.aws_ses import mixins as ses_mixins

suppression_options_property = ses_mixins.CfnConfigurationSetPropsMixin.SuppressionOptionsProperty(
    suppressed_reasons=["suppressedReasons"]
)

Attributes

suppressed_reasons

A list that contains the reasons that email addresses are automatically added to the suppression list for your account.

This list can contain any or all of the following:

COMPLAINT – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a complaint.
BOUNCE – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a hard bounce.

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

TrackingOptionsProperty

class CfnConfigurationSetPropsMixin.TrackingOptionsProperty(*, custom_redirect_domain=None, https_policy=None)

Bases: object

An object that defines the tracking options for a configuration set.

When you use the Amazon SES API v2 to send an email, it contains an invisible image that’s used to track when recipients open your email. If your email contains links, those links are changed slightly in order to track when recipients click them.

You can optionally configure a custom subdomain that is used to redirect email recipients to an Amazon SES-operated domain. This domain captures open and click events generated by Amazon SES emails.

For more information, see Configuring Custom Domains to Handle Open and Click Tracking in the Amazon SES Developer Guide .

Parameters:

custom_redirect_domain (Optional[str]) – The custom subdomain that is used to redirect email recipients to the Amazon SES event tracking domain.
https_policy (Optional[str]) – The name of the configuration set used when sent through a configuration set with archiving enabled.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-trackingoptions.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.mixins_preview.aws_ses import mixins as ses_mixins

tracking_options_property = ses_mixins.CfnConfigurationSetPropsMixin.TrackingOptionsProperty(
    custom_redirect_domain="customRedirectDomain",
    https_policy="httpsPolicy"
)

Attributes

custom_redirect_domain

The custom subdomain that is used to redirect email recipients to the Amazon SES event tracking domain.

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

https_policy

The name of the configuration set used when sent through a configuration set with archiving enabled.

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

VdmOptionsProperty

class CfnConfigurationSetPropsMixin.VdmOptionsProperty(*, dashboard_options=None, guardian_options=None)

Bases: object

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

Parameters:

dashboard_options (Union[IResolvable, DashboardOptionsProperty, Dict[str, Any], None]) – Specifies additional settings for your VDM configuration as applicable to the Dashboard.
guardian_options (Union[IResolvable, GuardianOptionsProperty, Dict[str, Any], None]) – Specifies additional settings for your VDM configuration as applicable to the Guardian.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-vdmoptions.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.mixins_preview.aws_ses import mixins as ses_mixins

vdm_options_property = ses_mixins.CfnConfigurationSetPropsMixin.VdmOptionsProperty(
    dashboard_options=ses_mixins.CfnConfigurationSetPropsMixin.DashboardOptionsProperty(
        engagement_metrics="engagementMetrics"
    ),
    guardian_options=ses_mixins.CfnConfigurationSetPropsMixin.GuardianOptionsProperty(
        optimized_shared_delivery="optimizedSharedDelivery"
    )
)

Attributes

dashboard_options

Specifies additional settings for your VDM configuration as applicable to the Dashboard.

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

guardian_options

Specifies additional settings for your VDM configuration as applicable to the Guardian.

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