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. The In-App channel is unavailable in AWS GovCloud (US).

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Pinpoint::InAppTemplate",
  "Properties" : {
      "Content" : [ InAppMessageContent, ... ],
      "CustomConfig" : Json,
      "Layout" : String,
      "Tags" : [ Tag, ... ],
      "TemplateDescription" : String,
      "TemplateName" : String
    }
}

YAML

Type: AWS::Pinpoint::InAppTemplate
Properties:
  Content: 
    - InAppMessageContent
  CustomConfig: Json
  Layout: String
  Tags: 
    - Tag
  TemplateDescription: String
  TemplateName: String

Properties

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.

Required: No

Type: Array of InAppMessageContent

Update requires: No interruption

CustomConfig

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

Required: No

Type: Json

Update requires: No interruption

Layout

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.

Required: No

Type: String

Allowed values: BOTTOM_BANNER | TOP_BANNER | OVERLAYS | MOBILE_FEED | MIDDLE_BANNER | CAROUSEL

Update requires: No interruption

Tags

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

For more information, see Tag.

Required: No

Type: Array of Tag

Update requires: No interruption

TemplateDescription

An optional description of the in-app template.

Required: No

Type: String

Update requires: No interruption

TemplateName

The name of the in-app message template.

Required: Yes

Type: String

Update requires: Replacement

Return values

Fn::GetAtt

Arn

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