AWS::Pinpoint::InAppTemplate DefaultButtonConfiguration - AWS CloudFormation
SyntaxProperties

AWS::Pinpoint::InAppTemplate DefaultButtonConfiguration

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.

Syntax

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

JSON

{
  "BackgroundColor" : String,
  "BorderRadius" : Integer,
  "ButtonAction" : String,
  "Link" : String,
  "Text" : String,
  "TextColor" : String
}

YAML

  BackgroundColor: String
  BorderRadius: Integer
  ButtonAction: String
  Link: String
  Text: String
  TextColor: String

Properties

BackgroundColor

The background color of a button, expressed as a hex color code (such as #000000 for black).

Required: No

Type: String

Update requires: No interruption

BorderRadius

The border radius of a button.

Required: No

Type: Integer

Update requires: No interruption

ButtonAction

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.

Required: No

Type: String

Allowed values: LINK | DEEP_LINK | CLOSE

Update requires: No interruption

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

Required: No

Type: String

Update requires: No interruption

Text

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

Required: No

Type: String

Update requires: No interruption

TextColor

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

Required: No

Type: String

Update requires: No interruption