Interface CfnDashboard.IVisualCustomActionProperty

A custom action defined on a visual.

Namespace: Amazon.CDK.AWS.QuickSight
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IVisualCustomActionProperty
Syntax (vb)
Public Interface IVisualCustomActionProperty
Remarks

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

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.QuickSight;

var visualCustomActionProperty = new VisualCustomActionProperty {
    ActionOperations = new [] { new VisualCustomActionOperationProperty {
        FilterOperation = new CustomActionFilterOperationProperty {
            SelectedFieldsConfiguration = new FilterOperationSelectedFieldsConfigurationProperty {
                SelectedColumns = new [] { new ColumnIdentifierProperty {
                    ColumnName = "columnName",
                    DataSetIdentifier = "dataSetIdentifier"
                } },
                SelectedFieldOptions = "selectedFieldOptions",
                SelectedFields = new [] { "selectedFields" }
            },
            TargetVisualsConfiguration = new FilterOperationTargetVisualsConfigurationProperty {
                SameSheetTargetVisualConfiguration = new SameSheetTargetVisualConfigurationProperty {
                    TargetVisualOptions = "targetVisualOptions",
                    TargetVisuals = new [] { "targetVisuals" }
                }
            }
        },
        NavigationOperation = new CustomActionNavigationOperationProperty {
            LocalNavigationConfiguration = new LocalNavigationConfigurationProperty {
                TargetSheetId = "targetSheetId"
            }
        },
        SetParametersOperation = new CustomActionSetParametersOperationProperty {
            ParameterValueConfigurations = new [] { new SetParameterValueConfigurationProperty {
                DestinationParameterName = "destinationParameterName",
                Value = new DestinationParameterValueConfigurationProperty {
                    CustomValuesConfiguration = new CustomValuesConfigurationProperty {
                        CustomValues = new CustomParameterValuesProperty {
                            DateTimeValues = new [] { "dateTimeValues" },
                            DecimalValues = new [] { 123 },
                            IntegerValues = new [] { 123 },
                            StringValues = new [] { "stringValues" }
                        },

                        // the properties below are optional
                        IncludeNullValue = false
                    },
                    SelectAllValueOptions = "selectAllValueOptions",
                    SourceColumn = new ColumnIdentifierProperty {
                        ColumnName = "columnName",
                        DataSetIdentifier = "dataSetIdentifier"
                    },
                    SourceField = "sourceField",
                    SourceParameterName = "sourceParameterName"
                }
            } }
        },
        UrlOperation = new CustomActionURLOperationProperty {
            UrlTarget = "urlTarget",
            UrlTemplate = "urlTemplate"
        }
    } },
    CustomActionId = "customActionId",
    Name = "name",
    Trigger = "trigger",

    // the properties below are optional
    Status = "status"
};

Synopsis

Properties

ActionOperations

A list of VisualCustomActionOperations .
CustomActionId

The ID of the VisualCustomAction .
Name

The name of the VisualCustomAction .
Status

The status of the VisualCustomAction .
Trigger

The trigger of the VisualCustomAction .

Properties

ActionOperations

A list of VisualCustomActionOperations .

object ActionOperations { get; }
Property Value

System.Object

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visualcustomaction.html#cfn-quicksight-dashboard-visualcustomaction-actionoperations

CustomActionId

The ID of the VisualCustomAction .

string CustomActionId { get; }
Property Value

System.String

Remarks

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

Name

The name of the VisualCustomAction .

string Name { get; }
Property Value

System.String

Remarks

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

Status

The status of the VisualCustomAction .

virtual string Status { get; }
Property Value

System.String

Remarks

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

Trigger

The trigger of the VisualCustomAction .

string Trigger { get; }
Property Value

System.String

Remarks

Valid values are defined as follows:

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