Package software.amazon.awscdk.services.quicksight

Interface CfnDashboard.VisualCustomActionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDashboard.VisualCustomActionProperty.Jsii$Proxy

Enclosing class:

CfnDashboard

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

A custom action defined on a visual.

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.*;
 VisualCustomActionProperty visualCustomActionProperty = 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())
                                                 // the properties below are optional
                                                 .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")
         .trigger("trigger")
         // the properties below are optional
         .status("status")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDashboard.VisualCustomActionProperty.Builder	builder()
Object	getActionOperations()	A list of VisualCustomActionOperations .
String	getCustomActionId()	The ID of the VisualCustomAction .
String	getName()	The name of the VisualCustomAction .
default String	getStatus()	The status of the VisualCustomAction .
String	getTrigger()	The trigger of the VisualCustomAction .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getActionOperations

@Stability(Stable)
@NotNull
Object getActionOperations()

A list of VisualCustomActionOperations .

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

See Also:

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

getCustomActionId

@Stability(Stable)
@NotNull
String getCustomActionId()

The ID of the VisualCustomAction .

See Also:

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

getName

@Stability(Stable)
@NotNull
String getName()

The name of the VisualCustomAction .

See Also:

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

getTrigger

@Stability(Stable)
@NotNull
String getTrigger()

The trigger of the VisualCustomAction .

Valid values are defined as follows:

• DATA_POINT_CLICK : Initiates a custom action by a left pointer click on a data point.
• DATA_POINT_MENU : Initiates a custom action by right pointer click from the menu.

See Also:

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

getStatus

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

The status of the VisualCustomAction .

See Also:

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

builder

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

Returns:

a CfnDashboard.VisualCustomActionProperty.Builder of CfnDashboard.VisualCustomActionProperty