Package software.amazon.awscdk.mixins.preview.services.quicksight.mixins

Interface CfnTemplatePropsMixin.ImageCustomActionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTemplatePropsMixin.ImageCustomActionProperty.Jsii$Proxy

Enclosing class:

CfnTemplatePropsMixin

@Stability(Stable)
public static interface CfnTemplatePropsMixin.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.mixins.preview.services.quicksight.mixins.*;
 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())
                                                 .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")
         .status("status")
         .trigger("trigger")
         .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	CfnTemplatePropsMixin.ImageCustomActionProperty.Builder	A builder for CfnTemplatePropsMixin.ImageCustomActionProperty
static final class	CfnTemplatePropsMixin.ImageCustomActionProperty.Jsii$Proxy	An implementation for CfnTemplatePropsMixin.ImageCustomActionProperty

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getActionOperations

@Stability(Stable)
@Nullable
default 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 CfnTemplatePropsMixin.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)
@Nullable
default 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)
@Nullable
default 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

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

getTrigger

@Stability(Stable)
@Nullable
default 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

builder

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

Returns:

a CfnTemplatePropsMixin.ImageCustomActionProperty.Builder of CfnTemplatePropsMixin.ImageCustomActionProperty