Class CfnDashboard.ParameterDeclarationProperty

The declaration definition of a parameter.

Inheritance
System.Object
CfnDashboard.ParameterDeclarationProperty
Namespace: Amazon.CDK.AWS.QuickSight
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class ParameterDeclarationProperty : Object, CfnDashboard.IParameterDeclarationProperty
Syntax (vb)
Public Class ParameterDeclarationProperty
    Inherits Object
    Implements CfnDashboard.IParameterDeclarationProperty
Remarks

For more information, see Parameters in Amazon QuickSight in the Amazon QuickSight User Guide .

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-parameterdeclaration.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 parameterDeclarationProperty = new ParameterDeclarationProperty {
    DateTimeParameterDeclaration = new DateTimeParameterDeclarationProperty {
        Name = "name",

        // the properties below are optional
        DefaultValues = new DateTimeDefaultValuesProperty {
            DynamicValue = new DynamicDefaultValueProperty {
                DefaultValueColumn = new ColumnIdentifierProperty {
                    ColumnName = "columnName",
                    DataSetIdentifier = "dataSetIdentifier"
                },

                // the properties below are optional
                GroupNameColumn = new ColumnIdentifierProperty {
                    ColumnName = "columnName",
                    DataSetIdentifier = "dataSetIdentifier"
                },
                UserNameColumn = new ColumnIdentifierProperty {
                    ColumnName = "columnName",
                    DataSetIdentifier = "dataSetIdentifier"
                }
            },
            RollingDate = new RollingDateConfigurationProperty {
                Expression = "expression",

                // the properties below are optional
                DataSetIdentifier = "dataSetIdentifier"
            },
            StaticValues = new [] { "staticValues" }
        },
        MappedDataSetParameters = new [] { new MappedDataSetParameterProperty {
            DataSetIdentifier = "dataSetIdentifier",
            DataSetParameterName = "dataSetParameterName"
        } },
        TimeGranularity = "timeGranularity",
        ValueWhenUnset = new DateTimeValueWhenUnsetConfigurationProperty {
            CustomValue = "customValue",
            ValueWhenUnsetOption = "valueWhenUnsetOption"
        }
    },
    DecimalParameterDeclaration = new DecimalParameterDeclarationProperty {
        Name = "name",
        ParameterValueType = "parameterValueType",

        // the properties below are optional
        DefaultValues = new DecimalDefaultValuesProperty {
            DynamicValue = new DynamicDefaultValueProperty {
                DefaultValueColumn = new ColumnIdentifierProperty {
                    ColumnName = "columnName",
                    DataSetIdentifier = "dataSetIdentifier"
                },

                // the properties below are optional
                GroupNameColumn = new ColumnIdentifierProperty {
                    ColumnName = "columnName",
                    DataSetIdentifier = "dataSetIdentifier"
                },
                UserNameColumn = new ColumnIdentifierProperty {
                    ColumnName = "columnName",
                    DataSetIdentifier = "dataSetIdentifier"
                }
            },
            StaticValues = new [] { 123 }
        },
        MappedDataSetParameters = new [] { new MappedDataSetParameterProperty {
            DataSetIdentifier = "dataSetIdentifier",
            DataSetParameterName = "dataSetParameterName"
        } },
        ValueWhenUnset = new DecimalValueWhenUnsetConfigurationProperty {
            CustomValue = 123,
            ValueWhenUnsetOption = "valueWhenUnsetOption"
        }
    },
    IntegerParameterDeclaration = new IntegerParameterDeclarationProperty {
        Name = "name",
        ParameterValueType = "parameterValueType",

        // the properties below are optional
        DefaultValues = new IntegerDefaultValuesProperty {
            DynamicValue = new DynamicDefaultValueProperty {
                DefaultValueColumn = new ColumnIdentifierProperty {
                    ColumnName = "columnName",
                    DataSetIdentifier = "dataSetIdentifier"
                },

                // the properties below are optional
                GroupNameColumn = new ColumnIdentifierProperty {
                    ColumnName = "columnName",
                    DataSetIdentifier = "dataSetIdentifier"
                },
                UserNameColumn = new ColumnIdentifierProperty {
                    ColumnName = "columnName",
                    DataSetIdentifier = "dataSetIdentifier"
                }
            },
            StaticValues = new [] { 123 }
        },
        MappedDataSetParameters = new [] { new MappedDataSetParameterProperty {
            DataSetIdentifier = "dataSetIdentifier",
            DataSetParameterName = "dataSetParameterName"
        } },
        ValueWhenUnset = new IntegerValueWhenUnsetConfigurationProperty {
            CustomValue = 123,
            ValueWhenUnsetOption = "valueWhenUnsetOption"
        }
    },
    StringParameterDeclaration = new StringParameterDeclarationProperty {
        Name = "name",
        ParameterValueType = "parameterValueType",

        // the properties below are optional
        DefaultValues = new StringDefaultValuesProperty {
            DynamicValue = new DynamicDefaultValueProperty {
                DefaultValueColumn = new ColumnIdentifierProperty {
                    ColumnName = "columnName",
                    DataSetIdentifier = "dataSetIdentifier"
                },

                // the properties below are optional
                GroupNameColumn = new ColumnIdentifierProperty {
                    ColumnName = "columnName",
                    DataSetIdentifier = "dataSetIdentifier"
                },
                UserNameColumn = new ColumnIdentifierProperty {
                    ColumnName = "columnName",
                    DataSetIdentifier = "dataSetIdentifier"
                }
            },
            StaticValues = new [] { "staticValues" }
        },
        MappedDataSetParameters = new [] { new MappedDataSetParameterProperty {
            DataSetIdentifier = "dataSetIdentifier",
            DataSetParameterName = "dataSetParameterName"
        } },
        ValueWhenUnset = new StringValueWhenUnsetConfigurationProperty {
            CustomValue = "customValue",
            ValueWhenUnsetOption = "valueWhenUnsetOption"
        }
    }
};

Synopsis

Constructors

ParameterDeclarationProperty()

Properties

DateTimeParameterDeclaration

A parameter declaration for the DateTime data type.
DecimalParameterDeclaration

A parameter declaration for the Decimal data type.
IntegerParameterDeclaration

A parameter declaration for the Integer data type.
StringParameterDeclaration

A parameter declaration for the String data type.

Constructors

ParameterDeclarationProperty()

public ParameterDeclarationProperty()

Properties

DateTimeParameterDeclaration

A parameter declaration for the DateTime data type.

public object DateTimeParameterDeclaration { get; set; }
Property Value

System.Object

Remarks

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

DecimalParameterDeclaration

A parameter declaration for the Decimal data type.

public object DecimalParameterDeclaration { get; set; }
Property Value

System.Object

Remarks

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

IntegerParameterDeclaration

A parameter declaration for the Integer data type.

public object IntegerParameterDeclaration { get; set; }
Property Value

System.Object

Remarks

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

StringParameterDeclaration

A parameter declaration for the String data type.

public object StringParameterDeclaration { get; set; }
Property Value

System.Object

Remarks

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

Implements