interface LayerCustomActionProperty

Language	Type name
.NET	`Amazon.CDK.AWS.QuickSight.CfnDashboard.LayerCustomActionProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnDashboard_LayerCustomActionProperty`
Java	`software.amazon.awscdk.services.quicksight.CfnDashboard.LayerCustomActionProperty`
Python	`aws_cdk.aws_quicksight.CfnDashboard.LayerCustomActionProperty`
TypeScript	`aws-cdk-lib` » `aws_quicksight` » `CfnDashboard` » `LayerCustomActionProperty`

A layer custom action.

Example

// 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',
          dataSetIdentifier: 'dataSetIdentifier',
        }],
        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',
            dataSetIdentifier: 'dataSetIdentifier',
          },
          sourceField: 'sourceField',
          sourceParameterName: 'sourceParameterName',
        },
      }],
    },
    urlOperation: {
      urlTarget: 'urlTarget',
      urlTemplate: 'urlTemplate',
    },
  }],
  customActionId: 'customActionId',
  name: 'name',
  trigger: 'trigger',

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

Properties

Name	Type	Description
actionOperations	`IResolvable` `\| (IResolvable` `\|` `LayerCustomActionOperationProperty)[]`	A list of `LayerCustomActionOperations` .
customActionId	`string`	The ID of the custom action.
name	`string`	The name of the custom action.
trigger	`string`	The trigger of the `LayerCustomAction` .
status?	`string`	The status of the `LayerCustomAction` .

actionOperations

Type: IResolvable | (IResolvable | LayerCustomActionOperationProperty)[]

A list of LayerCustomActionOperations .

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

customActionId

Type: string

The ID of the custom action.

name

Type: string

The name of the custom action.

trigger

Type: string

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.

status?

Type: string (optional)

The status of the LayerCustomAction .