CfnTemplatePropsMixin

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

Bases: Mixin

Specifies an email template.

Email templates enable you to send personalized email to one or more destinations in a single API operation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-template.html
CloudformationResource:: AWS::SES::Template
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_template_props_mixin = ses_mixins.CfnTemplatePropsMixin(ses_mixins.CfnTemplateMixinProps(
    template=ses_mixins.CfnTemplatePropsMixin.TemplateProperty(
        html_part="htmlPart",
        subject_part="subjectPart",
        template_name="templateName",
        text_part="textPart"
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnTemplateMixinProps, 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 = ['template']

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

TemplateProperty

class CfnTemplatePropsMixin.TemplateProperty(*, html_part=None, subject_part=None, template_name=None, text_part=None)

Bases: object

An object that defines the email template to use for an email message, and the values to use for any message variables in that template.

An email template is a type of message template that contains content that you want to reuse in email messages that you send. You can specifiy the email template by providing the name or ARN of an email template previously saved in your Amazon SES account or by providing the full template content.

Parameters:

html_part (Optional[str]) – The HTML body of the email.
subject_part (Optional[str]) – The subject line of the email.
template_name (Optional[str]) – The name of the template. You will refer to this name when you send email using the SendEmail or SendBulkEmail operations.
text_part (Optional[str]) – The email body that is visible to recipients whose email clients do not display HTML content.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-template-template.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

template_property = ses_mixins.CfnTemplatePropsMixin.TemplateProperty(
    html_part="htmlPart",
    subject_part="subjectPart",
    template_name="templateName",
    text_part="textPart"
)

Attributes

html_part

The HTML body of the email.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-template-template.html#cfn-ses-template-template-htmlpart

subject_part

The subject line of the email.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-template-template.html#cfn-ses-template-template-subjectpart

template_name

The name of the template.

You will refer to this name when you send email using the SendEmail or SendBulkEmail operations.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-template-template.html#cfn-ses-template-template-templatename

text_part

The email body that is visible to recipients whose email clients do not display HTML content.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-template-template.html#cfn-ses-template-template-textpart