Package software.amazon.awscdk.services.quicksight

Interface CfnTemplate.PluginVisualProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTemplate.PluginVisualProperty.Jsii$Proxy

Enclosing class:

CfnTemplate

@Stability(Stable)
public static interface CfnTemplate.PluginVisualProperty
extends software.amazon.jsii.JsiiSerializable

A flexible visualization type that allows engineers to create new custom charts in Quick Sight.

Example:

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTemplate.PluginVisualProperty.Builder	builder()
default Object	getChartConfiguration()	A description of the plugin field wells and their persisted properties.
String	getPluginArn()	The Amazon Resource Name (ARN) that reflects the plugin and version.
default Object	getSubtitle()	Returns union: either IResolvable or CfnTemplate.VisualSubtitleLabelOptionsProperty
default Object	getTitle()	Returns union: either IResolvable or CfnTemplate.VisualTitleLabelOptionsProperty
default String	getVisualContentAltText()	The alt text for the visual.
String	getVisualId()	The ID of the visual that you want to use.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPluginArn

@Stability(Stable)
@NotNull
String getPluginArn()

The Amazon Resource Name (ARN) that reflects the plugin and version.

See Also:

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

getVisualId

@Stability(Stable)
@NotNull
String getVisualId()

The ID of the visual that you want to use.

See Also:

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

getChartConfiguration

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

A description of the plugin field wells and their persisted properties.

Returns union: either IResolvable or CfnTemplate.PluginVisualConfigurationProperty

See Also:

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

getSubtitle

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

Returns union: either IResolvable or CfnTemplate.VisualSubtitleLabelOptionsProperty

See Also:

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

getTitle

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

Returns union: either IResolvable or CfnTemplate.VisualTitleLabelOptionsProperty

See Also:

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

builder

@Stability(Stable)
static CfnTemplate.PluginVisualProperty.Builder builder()

Returns:

a CfnTemplate.PluginVisualProperty.Builder of CfnTemplate.PluginVisualProperty