Interface CfnTemplate.VisualCustomActionProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnTemplate.VisualCustomActionProperty.Jsii$Proxy
- Enclosing class:
CfnTemplate
@Stability(Stable)
public static interface CfnTemplate.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:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnTemplate.VisualCustomActionProperty
static final class
An implementation forCfnTemplate.VisualCustomActionProperty
-
Method Summary
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getActionOperations
A list ofVisualCustomActionOperations
.This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
- See Also:
-
getCustomActionId
The ID of theVisualCustomAction
.- See Also:
-
getName
The name of theVisualCustomAction
.- See Also:
-
getTrigger
The trigger of theVisualCustomAction
.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:
-
getStatus
The status of theVisualCustomAction
.- See Also:
-
builder
-