CfnConfigurationSetPropsMixin

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

Bases: Mixin

Create a configuration set.

Configuration sets are groups of rules that you can apply to the emails you send using Amazon Pinpoint. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-configurationset.html
CloudformationResource:: AWS::PinpointEmail::ConfigurationSet
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

from aws_cdk import CfnTag
# 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_pinpointemail import mixins as pinpointemail_mixins

cfn_configuration_set_props_mixin = pinpointemail_mixins.CfnConfigurationSetPropsMixin(pinpointemail_mixins.CfnConfigurationSetMixinProps(
    delivery_options=pinpointemail_mixins.CfnConfigurationSetPropsMixin.DeliveryOptionsProperty(
        sending_pool_name="sendingPoolName"
    ),
    name="name",
    reputation_options=pinpointemail_mixins.CfnConfigurationSetPropsMixin.ReputationOptionsProperty(
        reputation_metrics_enabled=False
    ),
    sending_options=pinpointemail_mixins.CfnConfigurationSetPropsMixin.SendingOptionsProperty(
        sending_enabled=False
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    tracking_options=pinpointemail_mixins.CfnConfigurationSetPropsMixin.TrackingOptionsProperty(
        custom_redirect_domain="customRedirectDomain"
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::PinpointEmail::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:: None

supports(construct)

Check if this mixin supports the given construct.

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

Attributes

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

Static Methods

classmethod is_mixin(x)

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.

DeliveryOptionsProperty

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

Bases: object

Used to associate a configuration set with a dedicated IP pool.

Parameters:: sending_pool_name (Optional[str]) – The name of the dedicated IP pool that you want to associate with the configuration set.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-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_pinpointemail import mixins as pinpointemail_mixins

delivery_options_property = pinpointemail_mixins.CfnConfigurationSetPropsMixin.DeliveryOptionsProperty(
    sending_pool_name="sendingPoolName"
)

Attributes

sending_pool_name

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

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

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-pinpointemail-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_pinpointemail import mixins as pinpointemail_mixins

reputation_options_property = pinpointemail_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-pinpointemail-configurationset-reputationoptions.html#cfn-pinpointemail-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-pinpointemail-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_pinpointemail import mixins as pinpointemail_mixins

sending_options_property = pinpointemail_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-pinpointemail-configurationset-sendingoptions.html#cfn-pinpointemail-configurationset-sendingoptions-sendingenabled

TrackingOptionsProperty

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

Bases: object

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

When you use Amazon Pinpoint 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.

These images and links include references to a domain operated by AWS . You can optionally configure Amazon Pinpoint to use a domain that you operate for these images and links.

Parameters:: custom_redirect_domain (Optional[str]) – The domain that you want to use for tracking open and click events.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-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_pinpointemail import mixins as pinpointemail_mixins

tracking_options_property = pinpointemail_mixins.CfnConfigurationSetPropsMixin.TrackingOptionsProperty(
    custom_redirect_domain="customRedirectDomain"
)

Attributes

custom_redirect_domain

The domain that you want to use for tracking open and click events.

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