Package software.amazon.awscdk.services.quicksight

Interface CfnTemplate.CustomContentVisualProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTemplate.CustomContentVisualProperty.Jsii$Proxy

Enclosing class:

CfnTemplate

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

A visual that contains custom content.

For more information, see Using custom visual content in the Amazon QuickSight User Guide .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.quicksight.*;
 CustomContentVisualProperty customContentVisualProperty = CustomContentVisualProperty.builder()
         .dataSetIdentifier("dataSetIdentifier")
         .visualId("visualId")
         // the properties below are optional
         .actions(List.of(VisualCustomActionProperty.builder()
                 .actionOperations(List.of(VisualCustomActionOperationProperty.builder()
                         .filterOperation(CustomActionFilterOperationProperty.builder()
                                 .selectedFieldsConfiguration(FilterOperationSelectedFieldsConfigurationProperty.builder()
                                         .selectedFieldOptions("selectedFieldOptions")
                                         .selectedFields(List.of("selectedFields"))
                                         .build())
                                 .targetVisualsConfiguration(FilterOperationTargetVisualsConfigurationProperty.builder()
                                         .sameSheetTargetVisualConfiguration(SameSheetTargetVisualConfigurationProperty.builder()
                                                 .targetVisualOptions("targetVisualOptions")
                                                 .targetVisuals(List.of("targetVisuals"))
                                                 .build())
                                         .build())
                                 .build())
                         .navigationOperation(CustomActionNavigationOperationProperty.builder()
                                 .localNavigationConfiguration(LocalNavigationConfigurationProperty.builder()
                                         .targetSheetId("targetSheetId")
                                         .build())
                                 .build())
                         .setParametersOperation(CustomActionSetParametersOperationProperty.builder()
                                 .parameterValueConfigurations(List.of(SetParameterValueConfigurationProperty.builder()
                                         .destinationParameterName("destinationParameterName")
                                         .value(DestinationParameterValueConfigurationProperty.builder()
                                                 .customValuesConfiguration(CustomValuesConfigurationProperty.builder()
                                                         .customValues(CustomParameterValuesProperty.builder()
                                                                 .dateTimeValues(List.of("dateTimeValues"))
                                                                 .decimalValues(List.of(123))
                                                                 .integerValues(List.of(123))
                                                                 .stringValues(List.of("stringValues"))
                                                                 .build())
                                                         // the properties below are optional
                                                         .includeNullValue(false)
                                                         .build())
                                                 .selectAllValueOptions("selectAllValueOptions")
                                                 .sourceField("sourceField")
                                                 .sourceParameterName("sourceParameterName")
                                                 .build())
                                         .build()))
                                 .build())
                         .urlOperation(CustomActionURLOperationProperty.builder()
                                 .urlTarget("urlTarget")
                                 .urlTemplate("urlTemplate")
                                 .build())
                         .build()))
                 .customActionId("customActionId")
                 .name("name")
                 .trigger("trigger")
                 // the properties below are optional
                 .status("status")
                 .build()))
         .chartConfiguration(CustomContentConfigurationProperty.builder()
                 .contentType("contentType")
                 .contentUrl("contentUrl")
                 .imageScaling("imageScaling")
                 .build())
         .subtitle(VisualSubtitleLabelOptionsProperty.builder()
                 .formatText(LongFormatTextProperty.builder()
                         .plainText("plainText")
                         .richText("richText")
                         .build())
                 .visibility("visibility")
                 .build())
         .title(VisualTitleLabelOptionsProperty.builder()
                 .formatText(ShortFormatTextProperty.builder()
                         .plainText("plainText")
                         .richText("richText")
                         .build())
                 .visibility("visibility")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTemplate.CustomContentVisualProperty.Builder	builder()
default Object	getActions()	The list of custom actions that are configured for a visual.
default Object	getChartConfiguration()	The configuration of a CustomContentVisual .
String	getDataSetIdentifier()	The dataset that is used to create the custom content 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

getDataSetIdentifier

@Stability(Stable)
@NotNull
String getDataSetIdentifier()

The dataset that is used to create the custom content visual.

You can't create a visual without a dataset.

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.

getActions

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

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

getChartConfiguration

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

The configuration of a CustomContentVisual .

getSubtitle

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

The subtitle that is displayed on the visual.

getTitle

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

The title that is displayed on the visual.

builder

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

Returns:

a CfnTemplate.CustomContentVisualProperty.Builder of CfnTemplate.CustomContentVisualProperty