Class CfnAnalysis.StringParameterDeclarationProperty

A parameter declaration for the String data type.

Inheritance

System.Object

CfnAnalysis.StringParameterDeclarationProperty

Implements

CfnAnalysis.IStringParameterDeclarationProperty

Namespace: Amazon.CDK.AWS.QuickSight

Assembly: Amazon.CDK.AWS.QuickSight.dll

Syntax (csharp)

public class StringParameterDeclarationProperty : Object, CfnAnalysis.IStringParameterDeclarationProperty

Syntax (vb)

Public Class StringParameterDeclarationProperty
    Inherits Object
    Implements CfnAnalysis.IStringParameterDeclarationProperty

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-stringparameterdeclaration.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 stringParameterDeclarationProperty = 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

StringParameterDeclarationProperty()

Properties

DefaultValues	The default values of a parameter.
MappedDataSetParameters	`CfnAnalysis.StringParameterDeclarationProperty.MappedDataSetParameters`.
Name	The name of the parameter that is being declared.
ParameterValueType	The value type determines whether the parameter is a single-value or multi-value parameter.
ValueWhenUnset	The configuration that defines the default value of a `String` parameter when a value has not been set.

Constructors

StringParameterDeclarationProperty()

public StringParameterDeclarationProperty()

Properties

DefaultValues

The default values of a parameter.

public object DefaultValues { get; set; }

Property Value

System.Object

Remarks

If the parameter is a single-value parameter, a maximum of one default value can be provided.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-stringparameterdeclaration.html#cfn-quicksight-analysis-stringparameterdeclaration-defaultvalues

MappedDataSetParameters

CfnAnalysis.StringParameterDeclarationProperty.MappedDataSetParameters.

public object MappedDataSetParameters { get; set; }

Property Value

System.Object

Remarks

Name

The name of the parameter that is being declared.

public string Name { get; set; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-stringparameterdeclaration.html#cfn-quicksight-analysis-stringparameterdeclaration-name

ParameterValueType

The value type determines whether the parameter is a single-value or multi-value parameter.

public string ParameterValueType { get; set; }

Property Value

System.String

Remarks

ValueWhenUnset

The configuration that defines the default value of a String parameter when a value has not been set.

public object ValueWhenUnset { get; set; }