Package software.amazon.awscdk.services.quicksight

Interface CfnTemplate.ImageCustomActionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTemplate.ImageCustomActionProperty.Jsii$Proxy

Enclosing class:

CfnTemplate

@Stability(Stable)
public static interface CfnTemplate.ImageCustomActionProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.quicksight.*;
 ImageCustomActionProperty imageCustomActionProperty = ImageCustomActionProperty.builder()
         .actionOperations(List.of(ImageCustomActionOperationProperty.builder()
                 .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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-imagecustomaction.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnTemplate.ImageCustomActionProperty.Builder	A builder for CfnTemplate.ImageCustomActionProperty
static final class	CfnTemplate.ImageCustomActionProperty.Jsii$Proxy	An implementation for CfnTemplate.ImageCustomActionProperty

Method Summary

Modifier and Type	Method	Description
static CfnTemplate.ImageCustomActionProperty.Builder	builder()
Object	getActionOperations()	A list of ImageCustomActionOperations .
String	getCustomActionId()	The ID of the custom action.
String	getName()	The name of the custom action.
default String	getStatus()	The status of the custom action.
String	getTrigger()	The trigger of the VisualCustomAction .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getActionOperations

@Stability(Stable)
@NotNull
Object getActionOperations()

A list of ImageCustomActionOperations .

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

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTemplate.ImageCustomActionOperationProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-imagecustomaction.html#cfn-quicksight-template-imagecustomaction-actionoperations

getCustomActionId

@Stability(Stable)
@NotNull
String getCustomActionId()

The ID of the custom action.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-imagecustomaction.html#cfn-quicksight-template-imagecustomaction-customactionid

getName

@Stability(Stable)
@NotNull
String getName()

The name of the custom action.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-imagecustomaction.html#cfn-quicksight-template-imagecustomaction-name

getTrigger

@Stability(Stable)
@NotNull
String getTrigger()

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-template-imagecustomaction.html#cfn-quicksight-template-imagecustomaction-trigger

getStatus

@Stability(Stable)
@Nullable
default String getStatus()

The status of the custom action.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-imagecustomaction.html#cfn-quicksight-template-imagecustomaction-status

builder

@Stability(Stable)
static CfnTemplate.ImageCustomActionProperty.Builder builder()

Returns:

a CfnTemplate.ImageCustomActionProperty.Builder of CfnTemplate.ImageCustomActionProperty