CfnConfigurationSetProps¶

class aws_cdk.aws_pinpointemail.CfnConfigurationSetProps(*, name, delivery_options=None, reputation_options=None, sending_options=None, tags=None, tracking_options=None)¶

Bases: object

Properties for defining a CfnConfigurationSet.

Parameters

name (str) – The name of the configuration set.
delivery_options (Union[DeliveryOptionsProperty, IResolvable, None]) – An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.
reputation_options (Union[IResolvable, ReputationOptionsProperty, None]) – An object that defines whether or not Amazon Pinpoint collects reputation metrics for the emails that you send that use the configuration set.
sending_options (Union[IResolvable, SendingOptionsProperty, None]) – An object that defines whether or not Amazon Pinpoint can send email that you send using the configuration set.
tags (Optional[Sequence[TagsProperty]]) – An object that defines the tags (keys and values) that you want to associate with the configuration set.
tracking_options (Union[IResolvable, TrackingOptionsProperty, None]) – An object that defines the open and click tracking options for emails that you send using the configuration set.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-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.
import aws_cdk.aws_pinpointemail as pinpointemail

cfn_configuration_set_props = pinpointemail.CfnConfigurationSetProps(
    name="name",

    # the properties below are optional
    delivery_options=pinpointemail.CfnConfigurationSet.DeliveryOptionsProperty(
        sending_pool_name="sendingPoolName"
    ),
    reputation_options=pinpointemail.CfnConfigurationSet.ReputationOptionsProperty(
        reputation_metrics_enabled=False
    ),
    sending_options=pinpointemail.CfnConfigurationSet.SendingOptionsProperty(
        sending_enabled=False
    ),
    tags=[pinpointemail.CfnConfigurationSet.TagsProperty(
        key="key",
        value="value"
    )],
    tracking_options=pinpointemail.CfnConfigurationSet.TrackingOptionsProperty(
        custom_redirect_domain="customRedirectDomain"
    )
)

Attributes

delivery_options¶

An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-configurationset.html#cfn-pinpointemail-configurationset-deliveryoptions
Return type: Union[DeliveryOptionsProperty, IResolvable, None]

name¶

The name of the configuration set.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-configurationset.html#cfn-pinpointemail-configurationset-name
Return type: str

reputation_options¶

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

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-configurationset.html#cfn-pinpointemail-configurationset-reputationoptions
Return type: Union[IResolvable, ReputationOptionsProperty, None]

sending_options¶

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

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-configurationset.html#cfn-pinpointemail-configurationset-sendingoptions
Return type: Union[IResolvable, SendingOptionsProperty, None]

tags¶

An object that defines the tags (keys and values) that you want to associate with the configuration set.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-configurationset.html#cfn-pinpointemail-configurationset-tags
Return type: Optional[List[TagsProperty]]

tracking_options¶

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

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-configurationset.html#cfn-pinpointemail-configurationset-trackingoptions
Return type: Union[IResolvable, TrackingOptionsProperty, None]