Interface CfnTemplate.IStringParameterDeclarationProperty

A parameter declaration for the String data type.

Namespace: Amazon.CDK.AWS.QuickSight

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnTemplate.IStringParameterDeclarationProperty

Syntax (vb)

Public Interface CfnTemplate.IStringParameterDeclarationProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-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

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.

Properties

DefaultValues

The default values of a parameter.

object? DefaultValues { get; }

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-template-stringparameterdeclaration.html#cfn-quicksight-template-stringparameterdeclaration-defaultvalues

MappedDataSetParameters

A parameter declaration for the String data type.

object? MappedDataSetParameters { get; }

Property Value

object

Remarks

Name

The name of the parameter that is being declared.

string Name { get; }

Property Value

string

Remarks

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

ParameterValueType

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

string ParameterValueType { get; }

Property Value

string

Remarks

ValueWhenUnset

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

object? ValueWhenUnset { get; }

Property Value

object