Package software.amazon.awscdk.cfnpropertymixins.services.quicksight

Interface CfnTemplatePropsMixin.KPIVisualProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTemplatePropsMixin.KPIVisualProperty.Jsii$Proxy

Enclosing class:

CfnTemplatePropsMixin

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

A key performance indicator (KPI).

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

Example:

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTemplatePropsMixin.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.
default String	getVisualContentAltText()	The alt text for the visual.
default String	getVisualId()	The unique identifier of a visual.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

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 CfnTemplatePropsMixin.VisualCustomActionProperty>

See Also:

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

getChartConfiguration

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

The configuration of a KPI visual.

Returns union: either IResolvable or CfnTemplatePropsMixin.KPIConfigurationProperty

See Also:

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

getColumnHierarchies

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

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

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTemplatePropsMixin.ColumnHierarchyProperty>

See Also:

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

getConditionalFormatting

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

The conditional formatting of a KPI visual.

Returns union: either IResolvable or CfnTemplatePropsMixin.KPIConditionalFormattingProperty

See Also:

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

getSubtitle

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

The subtitle that is displayed on the visual.

Returns union: either IResolvable or CfnTemplatePropsMixin.VisualSubtitleLabelOptionsProperty

See Also:

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

getTitle

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

The title that is displayed on the visual.

Returns union: either IResolvable or CfnTemplatePropsMixin.VisualTitleLabelOptionsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpivisual.html#cfn-quicksight-template-kpivisual-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-template-kpivisual.html#cfn-quicksight-template-kpivisual-visualcontentalttext

getVisualId

@Stability(Stable)
@Nullable
default 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-template-kpivisual.html#cfn-quicksight-template-kpivisual-visualid

builder

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

Returns:

a CfnTemplatePropsMixin.KPIVisualProperty.Builder of CfnTemplatePropsMixin.KPIVisualProperty