CfnInAppTemplate

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

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::Pinpoint::InAppTemplate.

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.

CloudformationResource

AWS::Pinpoint::InAppTemplate

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 = pinpoint.CfnInAppTemplate(self, "MyCfnInAppTemplate",
    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"
)

Create a new AWS::Pinpoint::InAppTemplate.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • 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.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

Any

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::Pinpoint::InAppTemplate'
attr_arn

The Amazon Resource Name (ARN) of the message template.

CloudformationAttribute

Arn

Return type

str

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

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]

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

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]

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

The construct tree node associated with this construct.

Return type

ConstructNode

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Return type

str

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

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

TagManager

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

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

BodyConfigProperty

class CfnInAppTemplate.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).

Link

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.
import aws_cdk.aws_pinpoint as pinpoint

body_config_property = pinpoint.CfnInAppTemplate.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 .

Link

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

Return type

Optional[str]

body

The main body text of the message.

Link

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

Return type

Optional[str]

text_color

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

Link

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

Return type

Optional[str]

ButtonConfigProperty

class CfnInAppTemplate.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.

Link

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.
import aws_cdk.aws_pinpoint as pinpoint

button_config_property = 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"
    )
)

Attributes

android

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

This button configuration overrides the default button configuration.

Link

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

Return type

Union[IResolvable, OverrideButtonConfigurationProperty, None]

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.

Link

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

Return type

Union[IResolvable, DefaultButtonConfigurationProperty, None]

ios

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

This button configuration overrides the default button configuration.

Link

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

Return type

Union[IResolvable, OverrideButtonConfigurationProperty, None]

web

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

This button configuration overrides the default button configuration.

Link

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

Return type

Union[IResolvable, OverrideButtonConfigurationProperty, None]

DefaultButtonConfigurationProperty

class CfnInAppTemplate.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).

Link

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.
import aws_cdk.aws_pinpoint as pinpoint

default_button_configuration_property = pinpoint.CfnInAppTemplate.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).

Link

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

Return type

Optional[str]

border_radius

The border radius of a button.

Link

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

Return type

Union[int, float, None]

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.

Link

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

Return type

Optional[str]

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

Link

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

Return type

Optional[str]

text

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

Link

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

Return type

Optional[str]

text_color

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

Link

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

Return type

Optional[str]

HeaderConfigProperty

class CfnInAppTemplate.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).

Link

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.
import aws_cdk.aws_pinpoint as pinpoint

header_config_property = pinpoint.CfnInAppTemplate.HeaderConfigProperty(
    alignment="alignment",
    header="header",
    text_color="textColor"
)

Attributes

alignment

The text alignment of the title of the message.

Acceptable values: LEFT , CENTER , RIGHT .

Link

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

Return type

Optional[str]

header

The title text of the in-app message.

Link

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

Return type

Optional[str]

text_color

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

Link

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

Return type

Optional[str]

InAppMessageContentProperty

class CfnInAppTemplate.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.

Link

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.
import aws_cdk.aws_pinpoint as pinpoint

in_app_message_content_property = 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"
        )
    )
)

Attributes

background_color

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

Link

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

Return type

Optional[str]

body_config

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

Link

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

Return type

Union[IResolvable, BodyConfigProperty, None]

header_config

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

Link

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

Return type

Union[IResolvable, HeaderConfigProperty, None]

image_url

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

Link

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

Return type

Optional[str]

primary_btn

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

Link

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

Return type

Union[IResolvable, ButtonConfigProperty, None]

secondary_btn

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

Link

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

Return type

Union[IResolvable, ButtonConfigProperty, None]

OverrideButtonConfigurationProperty

class CfnInAppTemplate.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.

Link

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.
import aws_cdk.aws_pinpoint as pinpoint

override_button_configuration_property = pinpoint.CfnInAppTemplate.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.

Link

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

Return type

Optional[str]

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

Link

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

Return type

Optional[str]