Package software.amazon.awscdk.services.quicksight

Interface CfnDashboard.KPIVisualProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDashboard.KPIVisualProperty.Jsii$Proxy

Enclosing class:

CfnDashboard

@Stability(Stable)
public static interface CfnDashboard.KPIVisualProperty
extends software.amazon.jsii.JsiiSerializable

A key performance indicator (KPI).

For more information, see Using KPIs in the Amazon QuickSight User Guide .

Example:

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDashboard.KPIVisualProperty.Builder	builder()
default Object	getActions()	The list of custom actions that are configured for a visual.
default Object	getChartConfiguration()	The configuration of a KPI visual.
default Object	getColumnHierarchies()	The column hierarchy that is used during drill-downs and drill-ups.
default Object	getConditionalFormatting()	The conditional formatting of a KPI visual.
default Object	getSubtitle()	The subtitle that is displayed on the visual.
default Object	getTitle()	The title that is displayed on the visual.
String	getVisualId()	The unique identifier of a visual.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

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-dashboard-kpivisual.html#cfn-quicksight-dashboard-kpivisual-visualid

getActions

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

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

See Also:

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

getChartConfiguration

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

The configuration of a KPI visual.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpivisual.html#cfn-quicksight-dashboard-kpivisual-chartconfiguration

getColumnHierarchies

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

The column hierarchy that is used during drill-downs and drill-ups.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpivisual.html#cfn-quicksight-dashboard-kpivisual-columnhierarchies

getConditionalFormatting

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

The conditional formatting of a KPI visual.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpivisual.html#cfn-quicksight-dashboard-kpivisual-conditionalformatting

getSubtitle

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

The subtitle that is displayed on the visual.

See Also:

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

getTitle

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

The title that is displayed on the visual.

See Also:

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

builder

@Stability(Stable)
static CfnDashboard.KPIVisualProperty.Builder builder()

Returns:

a CfnDashboard.KPIVisualProperty.Builder of CfnDashboard.KPIVisualProperty