StringParameterDeclarationProperty Struct
A parameter declaration for the String data type.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_quicksight as quicksight } from 'aws-cdk-lib';
const stringParameterDeclarationProperty: quicksight.CfnAnalysis.StringParameterDeclarationProperty = {
name: 'name',
parameterValueType: 'parameterValueType',
// the properties below are optional
defaultValues: {
dynamicValue: {
defaultValueColumn: {
columnName: 'columnName',
// the properties below are optional
dataSetIdentifier: 'dataSetIdentifier',
topicIdentifier: 'topicIdentifier',
},
// the properties below are optional
groupNameColumn: {
columnName: 'columnName',
// the properties below are optional
dataSetIdentifier: 'dataSetIdentifier',
topicIdentifier: 'topicIdentifier',
},
userNameColumn: {
columnName: 'columnName',
// the properties below are optional
dataSetIdentifier: 'dataSetIdentifier',
topicIdentifier: 'topicIdentifier',
},
},
staticValues: ['staticValues'],
},
mappedDataSetParameters: [{
dataSetIdentifier: 'dataSetIdentifier',
dataSetParameterName: 'dataSetParameterName',
}],
valueWhenUnset: {
customValue: 'customValue',
valueWhenUnsetOption: 'valueWhenUnsetOption',
},
};
Properties
defaultValuesoptionalIResolvable | CfnAnalysis.StringDefaultValuesPropertydefault_valuesoptionaltyping.Union[IResolvable, StringDefaultValuesProperty]defaultValuesoptionalIResolvableDefaultValuesoptionalIResolvableDefaultValuesoptionalinterface{}#The default values of a parameter.
If the parameter is a single-value parameter, a maximum of one default value can be provided.
mappedDataSetParametersoptionalIResolvable | IResolvable | CfnAnalysis.MappedDataSetParameterProperty[]mapped_data_set_parametersoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, MappedDataSetParameterProperty]]]mappedDataSetParametersoptionalIResolvableMappedDataSetParametersoptionalIResolvableMappedDataSetParametersoptionalinterface{}#The name of the parameter that is being declared.
parameterValueTypestringparameter_value_typestrparameterValueTypeStringParameterValueTypestringParameterValueType*stringrequired#The value type determines whether the parameter is a single-value or multi-value parameter.
valueWhenUnsetoptionalIResolvable | CfnAnalysis.StringValueWhenUnsetConfigurationPropertyvalue_when_unsetoptionaltyping.Union[IResolvable, StringValueWhenUnsetConfigurationProperty]valueWhenUnsetoptionalIResolvableValueWhenUnsetoptionalIResolvableValueWhenUnsetoptionalinterface{}#The configuration that defines the default value of a `String` parameter when a value has not been set.