AWS::QuickSight::Dashboard VisualMessageConfiguration - AWS CloudFormation
SyntaxProperties
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::QuickSight::Dashboard VisualMessageConfiguration

The configuration for a customizable message displayed on a visual. Supports parameter substitution in text fields.

Syntax

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

JSON

{
  "Description" : String,
  "DescriptionVisibility" : String,
  "Enabled" : Boolean,
  "LinkText" : String,
  "LinkUrl" : String,
  "LinkVisibility" : String,
  "Title" : String,
  "TitleVisibility" : String
}

YAML

  Description: String
  DescriptionVisibility: String
  Enabled: Boolean
  LinkText: String
  LinkUrl: String
  LinkVisibility: String
  Title: String
  TitleVisibility: String

Properties

Description

The description text of the message that is displayed on the visual.

Required: No

Type: String

Pattern: ^[^*;=`{}~\x00-\x08\x0E-\x1F\x7F]*$

Minimum: 0

Maximum: 120

Update requires: No interruption

DescriptionVisibility

Specifies whether the description of the message is displayed.

Required: No

Type: String

Allowed values: HIDDEN | VISIBLE

Update requires: No interruption

Enabled

Specifies whether the custom message is displayed on the visual. When set to true, the custom message appears in place of the default message. When set to false or omitted, the default message is displayed.

Required: No

Type: Boolean

Update requires: No interruption

LinkText

The display text of the hyperlink that is shown in the message.

Required: No

Type: String

Pattern: ^[^*;=`{}~\x00-\x08\x0E-\x1F\x7F]*$

Minimum: 0

Maximum: 120

Update requires: No interruption

LinkUrl

The destination URL of the hyperlink that is shown in the message. Only valid http, https, and mailto URLs are supported.

Required: No

Type: String

Pattern: ^(?:(?:[hH][tT][tT][pP][sS]?://|[mM][aA][iI][lL][tT][oO]:)\S*<<\$.+?>>\S*|[hH][tT][tT][pP][sS]?://[a-zA-Z\d.-]+\.[a-zA-Z]{2,63}(?::\d+)?(?:[/?#][^\s]*)?|[mM][aA][iI][lL][tT][oO]:[^\s@]+@[a-zA-Z\d.-]+\.[a-zA-Z]{2,63})$(?![\s\S])

Minimum: 0

Maximum: 120

Update requires: No interruption

LinkVisibility

Specifies whether the hyperlink in the message is displayed.

Required: No

Type: String

Allowed values: HIDDEN | VISIBLE

Update requires: No interruption

Title

The title text of the message that is displayed on the visual.

Required: No

Type: String

Pattern: ^[^*;=`{}~\x00-\x08\x0E-\x1F\x7F]*$

Minimum: 0

Maximum: 120

Update requires: No interruption

TitleVisibility

Specifies whether the title of the message is displayed.

Required: No

Type: String

Allowed values: HIDDEN | VISIBLE

Update requires: No interruption