interface ImageCustomActionProperty

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.QuickSight.Mixins.CfnDashboardPropsMixin.ImageCustomActionProperty
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsquicksight/mixins#CfnDashboardPropsMixin_ImageCustomActionProperty
Java	software.amazon.awscdk.mixins.preview.services.quicksight.mixins.CfnDashboardPropsMixin.ImageCustomActionProperty
Python	aws_cdk.mixins_preview.aws_quicksight.mixins.CfnDashboardPropsMixin.ImageCustomActionProperty
TypeScript	@aws-cdk/mixins-preview » aws_quicksight » mixins » CfnDashboardPropsMixin » ImageCustomActionProperty

A custom action defined on an image.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-imagecustomaction.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as quicksight_mixins } from '@aws-cdk/mixins-preview/aws-quicksight';
const imageCustomActionProperty: quicksight_mixins.CfnDashboardPropsMixin.ImageCustomActionProperty = {
  actionOperations: [{
    navigationOperation: {
      localNavigationConfiguration: {
        targetSheetId: 'targetSheetId',
      },
    },
    setParametersOperation: {
      parameterValueConfigurations: [{
        destinationParameterName: 'destinationParameterName',
        value: {
          customValuesConfiguration: {
            customValues: {
              dateTimeValues: ['dateTimeValues'],
              decimalValues: [123],
              integerValues: [123],
              stringValues: ['stringValues'],
            },
            includeNullValue: false,
          },
          selectAllValueOptions: 'selectAllValueOptions',
          sourceColumn: {
            columnName: 'columnName',
            dataSetIdentifier: 'dataSetIdentifier',
          },
          sourceField: 'sourceField',
          sourceParameterName: 'sourceParameterName',
        },
      }],
    },
    urlOperation: {
      urlTarget: 'urlTarget',
      urlTemplate: 'urlTemplate',
    },
  }],
  customActionId: 'customActionId',
  name: 'name',
  status: 'status',
  trigger: 'trigger',
};

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.
status?	string	The status of the custom action.
trigger?	string	The trigger of the VisualCustomAction .

---

actionOperations?

Type: IResolvable | (IResolvable | ImageCustomActionOperationProperty)[] (optional)

A list of ImageCustomActionOperations .

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-imagecustomaction.html#cfn-quicksight-dashboard-imagecustomaction-actionoperations

---

customActionId?

Type: string (optional)

The ID of the custom action.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-imagecustomaction.html#cfn-quicksight-dashboard-imagecustomaction-customactionid

---

name?

Type: string (optional)

The name of the custom action.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-imagecustomaction.html#cfn-quicksight-dashboard-imagecustomaction-name

---

status?

Type: string (optional)

The status of the custom action.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-imagecustomaction.html#cfn-quicksight-dashboard-imagecustomaction-status

---

trigger?

Type: string (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-imagecustomaction.html#cfn-quicksight-dashboard-imagecustomaction-trigger