AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::Pinpoint::InAppTemplate

CfnInAppTemplate

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

Import

import { CfnInAppTemplate } from 'aws-cdk-lib/aws-pinpoint';

Or use the module namespace:

import * as pinpoint from 'aws-cdk-lib/aws-pinpoint';
// pinpoint.CfnInAppTemplate

Properties

Configuration passed to the constructor as CfnInAppTemplateProps.

templateNameRequired
string

The name of the in-app message template.

contentOptional
IResolvable | IResolvable | InAppMessageContentProperty[]

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.

customConfigOptional
any

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

layoutOptional
string

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.

tagsOptional
any

An array of key-value pairs to apply to this resource. For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .

templateDescriptionOptional
string

An optional description of the in-app template.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::Pinpoint::InAppTemplateView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-pinpoint
CFN TypeAWS::Pinpoint::InAppTemplate
Properties6

Related Constructs

Explore This Service

External Links