quicksight/aws.sdk.kotlin.services.quicksight.model/VisualMessageConfiguration

VisualMessageConfiguration

class VisualMessageConfiguration

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

Types

Builder

class Builder

Companion

object Companion

Properties

description

val description: String?

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

descriptionVisibility

val descriptionVisibility: Visibility?

Specifies whether the description of the message is displayed.

enabled

val enabled: Boolean

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.

linkText

val linkText: String?

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

linkUrl

val linkUrl: String?

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

linkVisibility

val linkVisibility: Visibility?

Specifies whether the hyperlink in the message is displayed.

title

val title: String?

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

titleVisibility

val titleVisibility: Visibility?

Specifies whether the title of the message is displayed.

Functions

copy

inline fun copy(block: VisualMessageConfiguration.Builder.() -> Unit = {}): VisualMessageConfiguration

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String