CfnContactListPropsMixin

class aws_cdk.cfn_property_mixins.aws_ses.CfnContactListPropsMixin(props, *, strategy=None)

Bases: Mixin

A list that contains contacts that have subscribed to a particular topic or topics.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-contactlist.html
CloudformationResource:: AWS::SES::ContactList
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.cfn_property_mixins import aws_ses as ses
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_contact_list_props_mixin = ses.CfnContactListPropsMixin(ses.CfnContactListMixinProps(
    contact_list_name="contactListName",
    description="description",
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )],
    topics=[ses.CfnContactListPropsMixin.TopicProperty(
        default_subscription_status="defaultSubscriptionStatus",
        description="description",
        display_name="displayName",
        topic_name="topicName"
    )]
),
    strategy=merge_strategy
)

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

Parameters:

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

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 = ['contactListName', 'description', 'tags', 'topics']

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.

TopicProperty

class CfnContactListPropsMixin.TopicProperty(*, default_subscription_status=None, description=None, display_name=None, topic_name=None)

Bases: object

An interest group, theme, or label within a list.

Lists can have multiple topics.

Parameters:

default_subscription_status (Optional[str]) – The default subscription status to be applied to a contact if the contact has not noted their preference for subscribing to a topic.
description (Optional[str]) – A description of what the topic is about, which the contact will see.
display_name (Optional[str]) – The name of the topic the contact will see.
topic_name (Optional[str]) – The name of the topic.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-contactlist-topic.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.cfn_property_mixins import aws_ses as ses

topic_property = ses.CfnContactListPropsMixin.TopicProperty(
    default_subscription_status="defaultSubscriptionStatus",
    description="description",
    display_name="displayName",
    topic_name="topicName"
)

Attributes

default_subscription_status

The default subscription status to be applied to a contact if the contact has not noted their preference for subscribing to a topic.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-contactlist-topic.html#cfn-ses-contactlist-topic-defaultsubscriptionstatus

description

A description of what the topic is about, which the contact will see.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-contactlist-topic.html#cfn-ses-contactlist-topic-description

display_name

The name of the topic the contact will see.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-contactlist-topic.html#cfn-ses-contactlist-topic-displayname

topic_name

The name of the topic.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-contactlist-topic.html#cfn-ses-contactlist-topic-topicname