interface ImageCustomActionProperty

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

A custom action defined on an image.

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 imageCustomActionProperty: quicksight.CfnTemplate.ImageCustomActionProperty = {
  actionOperations: [{
    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` `\|` `ImageCustomActionOperationProperty)[]`	A list of `ImageCustomActionOperations` .
customActionId	`string`	The ID of the custom action.
name	`string`	The name of the custom action.
trigger	`string`	The trigger of the `VisualCustomAction` .
status?	`string`	The status of the custom action.

actionOperations

Type: IResolvable | (IResolvable | ImageCustomActionOperationProperty)[]

A list of ImageCustomActionOperations .

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 VisualCustomAction .

Valid values are defined as follows:

CLICK : Initiates a custom action by a left pointer click on a data point.
MENU : Initiates a custom action by right pointer click from the menu.

status?

Type: string (optional)

The status of the custom action.