CfnInAppTemplateProps

class aws_cdk.aws_pinpoint.CfnInAppTemplateProps(*, template_name, content=None, custom_config=None, layout=None, tags=None, template_description=None)

Bases: object

Properties for defining a CfnInAppTemplate.

Parameters
  • template_name (str) – The name of the in-app message template.

  • content (Union[IResolvable, Sequence[Union[IResolvable, InAppMessageContentProperty, Dict[str, Any]]], None]) – An object that contains information about the content of an in-app message, including its title and body text, text colors, background colors, images, buttons, and behaviors.

  • custom_config (Optional[Any]) – Custom data, in the form of key-value pairs, that is included in an in-app messaging payload.

  • layout (Optional[str]) – A string that determines the appearance of the in-app message. You can specify one of the following:. - BOTTOM_BANNER – a message that appears as a banner at the bottom of the page. - TOP_BANNER – a message that appears as a banner at the top of the page. - OVERLAYS – a message that covers entire screen. - MOBILE_FEED – a message that appears in a window in front of the page. - MIDDLE_BANNER – a message that appears as a banner in the middle of the page. - CAROUSEL – a scrollable layout of up to five unique messages.

  • tags (Optional[Any]) – An array of key-value pairs to apply to this resource. For more information, see Tag .

  • template_description (Optional[str]) – An optional description of the in-app template.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-inapptemplate.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_pinpoint as pinpoint

# custom_config: Any
# tags: Any

cfn_in_app_template_props = pinpoint.CfnInAppTemplateProps(
    template_name="templateName",

    # the properties below are optional
    content=[pinpoint.CfnInAppTemplate.InAppMessageContentProperty(
        background_color="backgroundColor",
        body_config=pinpoint.CfnInAppTemplate.BodyConfigProperty(
            alignment="alignment",
            body="body",
            text_color="textColor"
        ),
        header_config=pinpoint.CfnInAppTemplate.HeaderConfigProperty(
            alignment="alignment",
            header="header",
            text_color="textColor"
        ),
        image_url="imageUrl",
        primary_btn=pinpoint.CfnInAppTemplate.ButtonConfigProperty(
            android=pinpoint.CfnInAppTemplate.OverrideButtonConfigurationProperty(
                button_action="buttonAction",
                link="link"
            ),
            default_config=pinpoint.CfnInAppTemplate.DefaultButtonConfigurationProperty(
                background_color="backgroundColor",
                border_radius=123,
                button_action="buttonAction",
                link="link",
                text="text",
                text_color="textColor"
            ),
            ios=pinpoint.CfnInAppTemplate.OverrideButtonConfigurationProperty(
                button_action="buttonAction",
                link="link"
            ),
            web=pinpoint.CfnInAppTemplate.OverrideButtonConfigurationProperty(
                button_action="buttonAction",
                link="link"
            )
        ),
        secondary_btn=pinpoint.CfnInAppTemplate.ButtonConfigProperty(
            android=pinpoint.CfnInAppTemplate.OverrideButtonConfigurationProperty(
                button_action="buttonAction",
                link="link"
            ),
            default_config=pinpoint.CfnInAppTemplate.DefaultButtonConfigurationProperty(
                background_color="backgroundColor",
                border_radius=123,
                button_action="buttonAction",
                link="link",
                text="text",
                text_color="textColor"
            ),
            ios=pinpoint.CfnInAppTemplate.OverrideButtonConfigurationProperty(
                button_action="buttonAction",
                link="link"
            ),
            web=pinpoint.CfnInAppTemplate.OverrideButtonConfigurationProperty(
                button_action="buttonAction",
                link="link"
            )
        )
    )],
    custom_config=custom_config,
    layout="layout",
    tags=tags,
    template_description="templateDescription"
)

Attributes

content

An object that contains information about the content of an in-app message, including its title and body text, text colors, background colors, images, buttons, and behaviors.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, InAppMessageContentProperty]], None]

custom_config

Custom data, in the form of key-value pairs, that is included in an in-app messaging payload.

Link

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

Return type

Any

layout

.

  • BOTTOM_BANNER – a message that appears as a banner at the bottom of the page.

  • TOP_BANNER – a message that appears as a banner at the top of the page.

  • OVERLAYS – a message that covers entire screen.

  • MOBILE_FEED – a message that appears in a window in front of the page.

  • MIDDLE_BANNER – a message that appears as a banner in the middle of the page.

  • CAROUSEL – a scrollable layout of up to five unique messages.

Link

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

Type

A string that determines the appearance of the in-app message. You can specify one of the following

Return type

Optional[str]

tags

An array of key-value pairs to apply to this resource.

For more information, see Tag .

Link

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

Return type

Any

template_description

An optional description of the in-app template.

Link

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

Return type

Optional[str]

template_name

The name of the in-app message template.

Link

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

Return type

str