Specifies the configuration and contents of an in-app message.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{
"BackgroundColor" : String
,
"BodyConfig" : InAppMessageBodyConfig
,
"HeaderConfig" : InAppMessageHeaderConfig
,
"ImageUrl" : String
,
"PrimaryBtn" : InAppMessageButton
,
"SecondaryBtn" : InAppMessageButton
}
YAML
BackgroundColor: String
BodyConfig:
InAppMessageBodyConfig
HeaderConfig:
InAppMessageHeaderConfig
ImageUrl: String
PrimaryBtn:
InAppMessageButton
SecondaryBtn:
InAppMessageButton
Properties
BackgroundColor
-
The background color for an in-app message banner, expressed as a hex color code (such as #000000 for black).
Required: No
Type: String
Update requires: No interruption
BodyConfig
-
Specifies the configuration of main body text in an in-app message template.
Required: No
Type: InAppMessageBodyConfig
Update requires: No interruption
HeaderConfig
-
Specifies the configuration and content of the header or title text of the in-app message.
Required: No
Type: InAppMessageHeaderConfig
Update requires: No interruption
ImageUrl
-
The URL of the image that appears on an in-app message banner.
Required: No
Type: String
Update requires: No interruption
PrimaryBtn
-
An object that contains configuration information about the primary button in an in-app message.
Required: No
Type: InAppMessageButton
Update requires: No interruption
SecondaryBtn
-
An object that contains configuration information about the secondary button in an in-app message.
Required: No
Type: InAppMessageButton
Update requires: No interruption