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

Interface CfnAnalysisPropsMixin.CustomContentVisualProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAnalysisPropsMixin.CustomContentVisualProperty.Jsii$Proxy

Enclosing class:

CfnAnalysisPropsMixin

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

A visual that contains custom content.

For more information, see Using custom visual content in the Amazon Quick Suite 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.cfnpropertymixins.services.quicksight.*;
 CustomContentVisualProperty customContentVisualProperty = CustomContentVisualProperty.builder()
         .actions(List.of(VisualCustomActionProperty.builder()
                 .actionOperations(List.of(VisualCustomActionOperationProperty.builder()
                         .filterOperation(CustomActionFilterOperationProperty.builder()
                                 .selectedFieldsConfiguration(FilterOperationSelectedFieldsConfigurationProperty.builder()
                                         .selectedColumns(List.of(ColumnIdentifierProperty.builder()
                                                 .columnName("columnName")
                                                 .dataSetIdentifier("dataSetIdentifier")
                                                 .build()))
                                         .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())
                                                         .includeNullValue(false)
                                                         .build())
                                                 .selectAllValueOptions("selectAllValueOptions")
                                                 .sourceColumn(ColumnIdentifierProperty.builder()
                                                         .columnName("columnName")
                                                         .dataSetIdentifier("dataSetIdentifier")
                                                         .build())
                                                 .sourceField("sourceField")
                                                 .sourceParameterName("sourceParameterName")
                                                 .build())
                                         .build()))
                                 .build())
                         .urlOperation(CustomActionURLOperationProperty.builder()
                                 .urlTarget("urlTarget")
                                 .urlTemplate("urlTemplate")
                                 .build())
                         .build()))
                 .customActionId("customActionId")
                 .name("name")
                 .status("status")
                 .trigger("trigger")
                 .build()))
         .chartConfiguration(CustomContentConfigurationProperty.builder()
                 .contentType("contentType")
                 .contentUrl("contentUrl")
                 .imageScaling("imageScaling")
                 .interactions(VisualInteractionOptionsProperty.builder()
                         .contextMenuOption(ContextMenuOptionProperty.builder()
                                 .availabilityStatus("availabilityStatus")
                                 .build())
                         .visualMenuOption(VisualMenuOptionProperty.builder()
                                 .availabilityStatus("availabilityStatus")
                                 .build())
                         .build())
                 .build())
         .dataSetIdentifier("dataSetIdentifier")
         .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())
         .visualContentAltText("visualContentAltText")
         .visualId("visualId")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnAnalysisPropsMixin.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 .
default 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.
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 CfnAnalysisPropsMixin.VisualCustomActionProperty>

See Also:

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

getChartConfiguration

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

The configuration of a CustomContentVisual .

Returns union: either IResolvable or CfnAnalysisPropsMixin.CustomContentConfigurationProperty

See Also:

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

getDataSetIdentifier

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

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

You can't create a visual without a dataset.

See Also:

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

getSubtitle

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

The subtitle that is displayed on the visual.

Returns union: either IResolvable or CfnAnalysisPropsMixin.VisualSubtitleLabelOptionsProperty

See Also:

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

getTitle

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

The title that is displayed on the visual.

Returns union: either IResolvable or CfnAnalysisPropsMixin.VisualTitleLabelOptionsProperty

See Also:

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

builder

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

Returns:

a CfnAnalysisPropsMixin.CustomContentVisualProperty.Builder of CfnAnalysisPropsMixin.CustomContentVisualProperty