CfnInAppTemplatePropsMixin

class aws_cdk.mixins_preview.aws_pinpoint.mixins.CfnInAppTemplatePropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a message template that you can use to send in-app messages.

A message template is a set of content and settings that you can define, save, and reuse in messages for any of your Amazon Pinpoint applications. The In-App channel is unavailable in AWS GovCloud (US).

See:

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

CloudformationResource:

AWS::Pinpoint::InAppTemplate

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_pinpoint import mixins as pinpoint_mixins

# custom_config: Any
# tags: Any

cfn_in_app_template_props_mixin = pinpoint_mixins.CfnInAppTemplatePropsMixin(pinpoint_mixins.CfnInAppTemplateMixinProps(
    content=[pinpoint_mixins.CfnInAppTemplatePropsMixin.InAppMessageContentProperty(
        background_color="backgroundColor",
        body_config=pinpoint_mixins.CfnInAppTemplatePropsMixin.BodyConfigProperty(
            alignment="alignment",
            body="body",
            text_color="textColor"
        ),
        header_config=pinpoint_mixins.CfnInAppTemplatePropsMixin.HeaderConfigProperty(
            alignment="alignment",
            header="header",
            text_color="textColor"
        ),
        image_url="imageUrl",
        primary_btn=pinpoint_mixins.CfnInAppTemplatePropsMixin.ButtonConfigProperty(
            android=pinpoint_mixins.CfnInAppTemplatePropsMixin.OverrideButtonConfigurationProperty(
                button_action="buttonAction",
                link="link"
            ),
            default_config=pinpoint_mixins.CfnInAppTemplatePropsMixin.DefaultButtonConfigurationProperty(
                background_color="backgroundColor",
                border_radius=123,
                button_action="buttonAction",
                link="link",
                text="text",
                text_color="textColor"
            ),
            ios=pinpoint_mixins.CfnInAppTemplatePropsMixin.OverrideButtonConfigurationProperty(
                button_action="buttonAction",
                link="link"
            ),
            web=pinpoint_mixins.CfnInAppTemplatePropsMixin.OverrideButtonConfigurationProperty(
                button_action="buttonAction",
                link="link"
            )
        ),
        secondary_btn=pinpoint_mixins.CfnInAppTemplatePropsMixin.ButtonConfigProperty(
            android=pinpoint_mixins.CfnInAppTemplatePropsMixin.OverrideButtonConfigurationProperty(
                button_action="buttonAction",
                link="link"
            ),
            default_config=pinpoint_mixins.CfnInAppTemplatePropsMixin.DefaultButtonConfigurationProperty(
                background_color="backgroundColor",
                border_radius=123,
                button_action="buttonAction",
                link="link",
                text="text",
                text_color="textColor"
            ),
            ios=pinpoint_mixins.CfnInAppTemplatePropsMixin.OverrideButtonConfigurationProperty(
                button_action="buttonAction",
                link="link"
            ),
            web=pinpoint_mixins.CfnInAppTemplatePropsMixin.OverrideButtonConfigurationProperty(
                button_action="buttonAction",
                link="link"
            )
        )
    )],
    custom_config=custom_config,
    layout="layout",
    tags=tags,
    template_description="templateDescription",
    template_name="templateName"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

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 = ['content', 'customConfig', 'layout', 'tags', 'templateDescription', 'templateName']

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

BodyConfigProperty

class CfnInAppTemplatePropsMixin.BodyConfigProperty(*, alignment=None, body=None, text_color=None)

Bases: object

Specifies the configuration of the main body text of the in-app message.

Parameters:

  • alignment (Optional[str]) – The text alignment of the main body text of the message. Acceptable values: LEFT , CENTER , RIGHT .

  • body (Optional[str]) – The main body text of the message.

  • text_color (Optional[str]) – The color of the body text, expressed as a hex color code (such as #000000 for black).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-bodyconfig.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_pinpoint import mixins as pinpoint_mixins

body_config_property = pinpoint_mixins.CfnInAppTemplatePropsMixin.BodyConfigProperty(
    alignment="alignment",
    body="body",
    text_color="textColor"
)

Attributes

alignment

The text alignment of the main body text of the message.

Acceptable values: LEFT , CENTER , RIGHT .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-bodyconfig.html#cfn-pinpoint-inapptemplate-bodyconfig-alignment

body

The main body text of the message.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-bodyconfig.html#cfn-pinpoint-inapptemplate-bodyconfig-body

text_color

The color of the body text, expressed as a hex color code (such as #000000 for black).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-bodyconfig.html#cfn-pinpoint-inapptemplate-bodyconfig-textcolor

ButtonConfigProperty

class CfnInAppTemplatePropsMixin.ButtonConfigProperty(*, android=None, default_config=None, ios=None, web=None)

Bases: object

Specifies the behavior of buttons that appear in an in-app message template.

Parameters:

  • android (Union[IResolvable, OverrideButtonConfigurationProperty, Dict[str, Any], None]) – Optional button configuration to use for in-app messages sent to Android devices. This button configuration overrides the default button configuration.

  • default_config (Union[IResolvable, DefaultButtonConfigurationProperty, Dict[str, Any], None]) – Specifies the default behavior of a button that appears in an in-app message. You can optionally add button configurations that specifically apply to iOS, Android, or web browser users.

  • ios (Union[IResolvable, OverrideButtonConfigurationProperty, Dict[str, Any], None]) – Optional button configuration to use for in-app messages sent to iOS devices. This button configuration overrides the default button configuration.

  • web (Union[IResolvable, OverrideButtonConfigurationProperty, Dict[str, Any], None]) – Optional button configuration to use for in-app messages sent to web applications. This button configuration overrides the default button configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-buttonconfig.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_pinpoint import mixins as pinpoint_mixins

button_config_property = pinpoint_mixins.CfnInAppTemplatePropsMixin.ButtonConfigProperty(
    android=pinpoint_mixins.CfnInAppTemplatePropsMixin.OverrideButtonConfigurationProperty(
        button_action="buttonAction",
        link="link"
    ),
    default_config=pinpoint_mixins.CfnInAppTemplatePropsMixin.DefaultButtonConfigurationProperty(
        background_color="backgroundColor",
        border_radius=123,
        button_action="buttonAction",
        link="link",
        text="text",
        text_color="textColor"
    ),
    ios=pinpoint_mixins.CfnInAppTemplatePropsMixin.OverrideButtonConfigurationProperty(
        button_action="buttonAction",
        link="link"
    ),
    web=pinpoint_mixins.CfnInAppTemplatePropsMixin.OverrideButtonConfigurationProperty(
        button_action="buttonAction",
        link="link"
    )
)

Attributes

android

Optional button configuration to use for in-app messages sent to Android devices.

This button configuration overrides the default button configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-buttonconfig.html#cfn-pinpoint-inapptemplate-buttonconfig-android

default_config

Specifies the default behavior of a button that appears in an in-app message.

You can optionally add button configurations that specifically apply to iOS, Android, or web browser users.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-buttonconfig.html#cfn-pinpoint-inapptemplate-buttonconfig-defaultconfig

ios

Optional button configuration to use for in-app messages sent to iOS devices.

This button configuration overrides the default button configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-buttonconfig.html#cfn-pinpoint-inapptemplate-buttonconfig-ios

web

Optional button configuration to use for in-app messages sent to web applications.

This button configuration overrides the default button configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-buttonconfig.html#cfn-pinpoint-inapptemplate-buttonconfig-web

DefaultButtonConfigurationProperty

class CfnInAppTemplatePropsMixin.DefaultButtonConfigurationProperty(*, background_color=None, border_radius=None, button_action=None, link=None, text=None, text_color=None)

Bases: object

Specifies the default behavior of a button that appears in an in-app message.

You can optionally add button configurations that specifically apply to iOS, Android, or web browser users.

Parameters:

  • background_color (Optional[str]) – The background color of a button, expressed as a hex color code (such as #000000 for black).

  • border_radius (Union[int, float, None]) – The border radius of a button.

  • button_action (Optional[str]) – The action that occurs when a recipient chooses a button in an in-app message. You can specify one of the following: - LINK – A link to a web destination. - DEEP_LINK – A link to a specific page in an application. - CLOSE – Dismisses the message.

  • link (Optional[str]) – The destination (such as a URL) for a button.

  • text (Optional[str]) – The text that appears on a button in an in-app message.

  • text_color (Optional[str]) – The color of the body text in a button, expressed as a hex color code (such as #000000 for black).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-defaultbuttonconfiguration.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_pinpoint import mixins as pinpoint_mixins

default_button_configuration_property = pinpoint_mixins.CfnInAppTemplatePropsMixin.DefaultButtonConfigurationProperty(
    background_color="backgroundColor",
    border_radius=123,
    button_action="buttonAction",
    link="link",
    text="text",
    text_color="textColor"
)

Attributes

background_color

The background color of a button, expressed as a hex color code (such as #000000 for black).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-defaultbuttonconfiguration.html#cfn-pinpoint-inapptemplate-defaultbuttonconfiguration-backgroundcolor

border_radius

The border radius of a button.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-defaultbuttonconfiguration.html#cfn-pinpoint-inapptemplate-defaultbuttonconfiguration-borderradius

button_action

The action that occurs when a recipient chooses a button in an in-app message.

You can specify one of the following:

  • LINK – A link to a web destination.

  • DEEP_LINK – A link to a specific page in an application.

  • CLOSE – Dismisses the message.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-defaultbuttonconfiguration.html#cfn-pinpoint-inapptemplate-defaultbuttonconfiguration-buttonaction

The destination (such as a URL) for a button.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-defaultbuttonconfiguration.html#cfn-pinpoint-inapptemplate-defaultbuttonconfiguration-link

text

The text that appears on a button in an in-app message.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-defaultbuttonconfiguration.html#cfn-pinpoint-inapptemplate-defaultbuttonconfiguration-text

text_color

The color of the body text in a button, expressed as a hex color code (such as #000000 for black).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-defaultbuttonconfiguration.html#cfn-pinpoint-inapptemplate-defaultbuttonconfiguration-textcolor

HeaderConfigProperty

class CfnInAppTemplatePropsMixin.HeaderConfigProperty(*, alignment=None, header=None, text_color=None)

Bases: object

Specifies the configuration and content of the header or title text of the in-app message.

Parameters:

  • alignment (Optional[str]) – The text alignment of the title of the message. Acceptable values: LEFT , CENTER , RIGHT .

  • header (Optional[str]) – The title text of the in-app message.

  • text_color (Optional[str]) – The color of the title text, expressed as a hex color code (such as #000000 for black).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-headerconfig.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_pinpoint import mixins as pinpoint_mixins

header_config_property = pinpoint_mixins.CfnInAppTemplatePropsMixin.HeaderConfigProperty(
    alignment="alignment",
    header="header",
    text_color="textColor"
)

Attributes

alignment

The text alignment of the title of the message.

Acceptable values: LEFT , CENTER , RIGHT .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-headerconfig.html#cfn-pinpoint-inapptemplate-headerconfig-alignment

header

The title text of the in-app message.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-headerconfig.html#cfn-pinpoint-inapptemplate-headerconfig-header

text_color

The color of the title text, expressed as a hex color code (such as #000000 for black).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-headerconfig.html#cfn-pinpoint-inapptemplate-headerconfig-textcolor

InAppMessageContentProperty

class CfnInAppTemplatePropsMixin.InAppMessageContentProperty(*, background_color=None, body_config=None, header_config=None, image_url=None, primary_btn=None, secondary_btn=None)

Bases: object

Specifies the configuration of an in-app message, including its header, body, buttons, colors, and images.

Parameters:

  • background_color (Optional[str]) – The background color for an in-app message banner, expressed as a hex color code (such as #000000 for black).

  • body_config (Union[IResolvable, BodyConfigProperty, Dict[str, Any], None]) – An object that contains configuration information about the header or title text of the in-app message.

  • header_config (Union[IResolvable, HeaderConfigProperty, Dict[str, Any], None]) – An object that contains configuration information about the header or title text of the in-app message.

  • image_url (Optional[str]) – The URL of the image that appears on an in-app message banner.

  • primary_btn (Union[IResolvable, ButtonConfigProperty, Dict[str, Any], None]) – An object that contains configuration information about the primary button in an in-app message.

  • secondary_btn (Union[IResolvable, ButtonConfigProperty, Dict[str, Any], None]) – An object that contains configuration information about the secondary button in an in-app message.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-inappmessagecontent.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_pinpoint import mixins as pinpoint_mixins

in_app_message_content_property = pinpoint_mixins.CfnInAppTemplatePropsMixin.InAppMessageContentProperty(
    background_color="backgroundColor",
    body_config=pinpoint_mixins.CfnInAppTemplatePropsMixin.BodyConfigProperty(
        alignment="alignment",
        body="body",
        text_color="textColor"
    ),
    header_config=pinpoint_mixins.CfnInAppTemplatePropsMixin.HeaderConfigProperty(
        alignment="alignment",
        header="header",
        text_color="textColor"
    ),
    image_url="imageUrl",
    primary_btn=pinpoint_mixins.CfnInAppTemplatePropsMixin.ButtonConfigProperty(
        android=pinpoint_mixins.CfnInAppTemplatePropsMixin.OverrideButtonConfigurationProperty(
            button_action="buttonAction",
            link="link"
        ),
        default_config=pinpoint_mixins.CfnInAppTemplatePropsMixin.DefaultButtonConfigurationProperty(
            background_color="backgroundColor",
            border_radius=123,
            button_action="buttonAction",
            link="link",
            text="text",
            text_color="textColor"
        ),
        ios=pinpoint_mixins.CfnInAppTemplatePropsMixin.OverrideButtonConfigurationProperty(
            button_action="buttonAction",
            link="link"
        ),
        web=pinpoint_mixins.CfnInAppTemplatePropsMixin.OverrideButtonConfigurationProperty(
            button_action="buttonAction",
            link="link"
        )
    ),
    secondary_btn=pinpoint_mixins.CfnInAppTemplatePropsMixin.ButtonConfigProperty(
        android=pinpoint_mixins.CfnInAppTemplatePropsMixin.OverrideButtonConfigurationProperty(
            button_action="buttonAction",
            link="link"
        ),
        default_config=pinpoint_mixins.CfnInAppTemplatePropsMixin.DefaultButtonConfigurationProperty(
            background_color="backgroundColor",
            border_radius=123,
            button_action="buttonAction",
            link="link",
            text="text",
            text_color="textColor"
        ),
        ios=pinpoint_mixins.CfnInAppTemplatePropsMixin.OverrideButtonConfigurationProperty(
            button_action="buttonAction",
            link="link"
        ),
        web=pinpoint_mixins.CfnInAppTemplatePropsMixin.OverrideButtonConfigurationProperty(
            button_action="buttonAction",
            link="link"
        )
    )
)

Attributes

background_color

The background color for an in-app message banner, expressed as a hex color code (such as #000000 for black).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-inappmessagecontent.html#cfn-pinpoint-inapptemplate-inappmessagecontent-backgroundcolor

body_config

An object that contains configuration information about the header or title text of the in-app message.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-inappmessagecontent.html#cfn-pinpoint-inapptemplate-inappmessagecontent-bodyconfig

header_config

An object that contains configuration information about the header or title text of the in-app message.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-inappmessagecontent.html#cfn-pinpoint-inapptemplate-inappmessagecontent-headerconfig

image_url

The URL of the image that appears on an in-app message banner.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-inappmessagecontent.html#cfn-pinpoint-inapptemplate-inappmessagecontent-imageurl

primary_btn

An object that contains configuration information about the primary button in an in-app message.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-inappmessagecontent.html#cfn-pinpoint-inapptemplate-inappmessagecontent-primarybtn

secondary_btn

An object that contains configuration information about the secondary button in an in-app message.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-inappmessagecontent.html#cfn-pinpoint-inapptemplate-inappmessagecontent-secondarybtn

OverrideButtonConfigurationProperty

class CfnInAppTemplatePropsMixin.OverrideButtonConfigurationProperty(*, button_action=None, link=None)

Bases: object

Specifies the configuration of a button with settings that are specific to a certain device type.

Parameters:

  • button_action (Optional[str]) – The action that occurs when a recipient chooses a button in an in-app message. You can specify one of the following: - LINK – A link to a web destination. - DEEP_LINK – A link to a specific page in an application. - CLOSE – Dismisses the message.

  • link (Optional[str]) – The destination (such as a URL) for a button.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-overridebuttonconfiguration.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_pinpoint import mixins as pinpoint_mixins

override_button_configuration_property = pinpoint_mixins.CfnInAppTemplatePropsMixin.OverrideButtonConfigurationProperty(
    button_action="buttonAction",
    link="link"
)

Attributes

button_action

The action that occurs when a recipient chooses a button in an in-app message.

You can specify one of the following:

  • LINK – A link to a web destination.

  • DEEP_LINK – A link to a specific page in an application.

  • CLOSE – Dismisses the message.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-overridebuttonconfiguration.html#cfn-pinpoint-inapptemplate-overridebuttonconfiguration-buttonaction

The destination (such as a URL) for a button.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-overridebuttonconfiguration.html#cfn-pinpoint-inapptemplate-overridebuttonconfiguration-link