Package software.amazon.awscdk.services.quicksight

Interface CfnAnalysis.InsightVisualProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAnalysis.InsightVisualProperty.Jsii$Proxy

Enclosing class:

CfnAnalysis

@Stability(Stable)
public static interface CfnAnalysis.InsightVisualProperty
extends software.amazon.jsii.JsiiSerializable

An insight visual.

For more information, see Working with insights in the Amazon Quick Suite User Guide .

Example:

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-insightvisual.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnAnalysis.InsightVisualProperty.Builder	A builder for CfnAnalysis.InsightVisualProperty
static final class	CfnAnalysis.InsightVisualProperty.Jsii$Proxy	An implementation for CfnAnalysis.InsightVisualProperty

Method Summary

Modifier and Type	Method	Description
static CfnAnalysis.InsightVisualProperty.Builder	builder()
default Object	getActions()	The list of custom actions that are configured for a visual.
String	getDataSetIdentifier()	The dataset that is used in the insight visual.
default Object	getInsightConfiguration()	The configuration of an insight visual.
default Object	getSubtitle()	The subtitle that is displayed on the visual.
default Object	getTitle()	The title that is displayed on the visual.
default String	getVisualContentAltText()	The alt text for the visual.
String	getVisualId()	The unique identifier of a visual.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDataSetIdentifier

@Stability(Stable)
@NotNull
String getDataSetIdentifier()

The dataset that is used in the insight visual.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-insightvisual.html#cfn-quicksight-analysis-insightvisual-datasetidentifier

getVisualId

@Stability(Stable)
@NotNull
String getVisualId()

The unique identifier of a visual.

This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-insightvisual.html#cfn-quicksight-analysis-insightvisual-visualid

getActions

@Stability(Stable)
@Nullable
default Object getActions()

The list of custom actions that are configured for a visual.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnAnalysis.VisualCustomActionProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-insightvisual.html#cfn-quicksight-analysis-insightvisual-actions

getInsightConfiguration

@Stability(Stable)
@Nullable
default Object getInsightConfiguration()

The configuration of an insight visual.

Returns union: either IResolvable or CfnAnalysis.InsightConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-insightvisual.html#cfn-quicksight-analysis-insightvisual-insightconfiguration

getSubtitle

@Stability(Stable)
@Nullable
default Object getSubtitle()

The subtitle that is displayed on the visual.

Returns union: either IResolvable or CfnAnalysis.VisualSubtitleLabelOptionsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-insightvisual.html#cfn-quicksight-analysis-insightvisual-subtitle

getTitle

@Stability(Stable)
@Nullable
default Object getTitle()

The title that is displayed on the visual.

Returns union: either IResolvable or CfnAnalysis.VisualTitleLabelOptionsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-insightvisual.html#cfn-quicksight-analysis-insightvisual-title

getVisualContentAltText

@Stability(Stable)
@Nullable
default String getVisualContentAltText()

The alt text for the visual.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-insightvisual.html#cfn-quicksight-analysis-insightvisual-visualcontentalttext

builder

@Stability(Stable)
static CfnAnalysis.InsightVisualProperty.Builder builder()

Returns:

a CfnAnalysis.InsightVisualProperty.Builder of CfnAnalysis.InsightVisualProperty