Class CfnAnalysis.StringParameterDeclarationProperty

A parameter declaration for the String data type.

Inheritance

object

CfnAnalysis.StringParameterDeclarationProperty

Implements

CfnAnalysis.IStringParameterDeclarationProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.QuickSight

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnAnalysis.StringParameterDeclarationProperty : CfnAnalysis.IStringParameterDeclarationProperty

Syntax (vb)

Public Class CfnAnalysis.StringParameterDeclarationProperty Implements CfnAnalysis.IStringParameterDeclarationProperty

Remarks

See: 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()

A parameter declaration for the String data type.

Properties

DefaultValues	The default values of a parameter.
MappedDataSetParameters	A parameter declaration for the `String` data type.
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()

A parameter declaration for the String data type.

public StringParameterDeclarationProperty()

Remarks

See: 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"
                 }
             };

Properties

DefaultValues

The default values of a parameter.

public object? DefaultValues { get; set; }

Property Value

object

Remarks

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

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

Type union: either IResolvable or CfnAnalysis.IStringDefaultValuesProperty

MappedDataSetParameters

A parameter declaration for the String data type.

public object? MappedDataSetParameters { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnAnalysis.IMappedDataSetParameterProperty)[]

Name

The name of the parameter that is being declared.

public string Name { get; set; }

Property Value

string

Remarks

See: 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

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; }