Skip to content
v2.273.0

LayerCustomActionProperty Struct ​

A layer custom action.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_quicksight as quicksight } from 'aws-cdk-lib';
const layerCustomActionProperty: quicksight.CfnDashboard.LayerCustomActionProperty = {
  actionOperations: [{
    filterOperation: {
      selectedFieldsConfiguration: {
        selectedColumns: [{
          columnName: 'columnName',

          // the properties below are optional
          dataSetIdentifier: 'dataSetIdentifier',
          topicIdentifier: 'topicIdentifier',
        }],
        selectedFieldOptions: 'selectedFieldOptions',
        selectedFields: ['selectedFields'],
      },
      targetVisualsConfiguration: {
        sameSheetTargetVisualConfiguration: {
          targetVisualOptions: 'targetVisualOptions',
          targetVisuals: ['targetVisuals'],
        },
      },
    },
    navigationOperation: {
      localNavigationConfiguration: {
        targetSheetId: 'targetSheetId',
      },
    },
    setParametersOperation: {
      parameterValueConfigurations: [{
        destinationParameterName: 'destinationParameterName',
        value: {
          customValuesConfiguration: {
            customValues: {
              dateTimeValues: ['dateTimeValues'],
              decimalValues: [123],
              integerValues: [123],
              stringValues: ['stringValues'],
            },

            // the properties below are optional
            includeNullValue: false,
          },
          selectAllValueOptions: 'selectAllValueOptions',
          sourceColumn: {
            columnName: 'columnName',

            // the properties below are optional
            dataSetIdentifier: 'dataSetIdentifier',
            topicIdentifier: 'topicIdentifier',
          },
          sourceField: 'sourceField',
          sourceParameterName: 'sourceParameterName',
        },
      }],
    },
    urlOperation: {
      urlTarget: 'urlTarget',
      urlTemplate: 'urlTemplate',
    },
  }],
  customActionId: 'customActionId',
  name: 'name',
  trigger: 'trigger',

  // the properties below are optional
  status: 'status',
};

Properties ​

actionOperationsIResolvable | IResolvable | CfnDashboard.LayerCustomActionOperationProperty[]action_operationstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, LayerCustomActionOperationProperty]]]actionOperationsIResolvableActionOperationsIResolvableActionOperationsinterface{}required#
A list of `LayerCustomActionOperations` .

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

customActionIdstringcustom_action_idstrcustomActionIdStringCustomActionIdstringCustomActionId*stringrequired#
The ID of the custom action.
namestringnamestrnameStringNamestringName*stringrequired#
The name of the custom action.
statusstringstatusstrstatusStringStatusstringStatus*string#
The status of the `LayerCustomAction` .
triggerstringtriggerstrtriggerStringTriggerstringTrigger*stringrequired#
The trigger of the `LayerCustomAction` .

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.