CfnEmailChannelPropsMixin

class aws_cdk.cfn_property_mixins.aws_pinpoint.CfnEmailChannelPropsMixin(props, *, strategy=None)

Bases: Mixin

A channel is a type of platform that you can deliver messages to.

You can use the email channel to send email to users. Before you can use Amazon Pinpoint to send email, you must enable the email channel for an Amazon Pinpoint application.

The EmailChannel resource represents the status, identity, and other settings of the email channel for an application

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailchannel.html

CloudformationResource:

AWS::Pinpoint::EmailChannel

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_pinpoint as pinpoint
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_email_channel_props_mixin = pinpoint.CfnEmailChannelPropsMixin(pinpoint.CfnEmailChannelMixinProps(
    application_id="applicationId",
    configuration_set="configurationSet",
    enabled=False,
    from_address="fromAddress",
    identity="identity",
    orchestration_sending_role_arn="orchestrationSendingRoleArn",
    role_arn="roleArn"
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::Pinpoint::EmailChannel.

Parameters:
  • props (Union[CfnEmailChannelMixinProps, 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 = ['applicationId', 'configurationSet', 'enabled', 'fromAddress', 'identity', 'orchestrationSendingRoleArn', 'roleArn']

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.