# StringParameterDeclarationProperty

A parameter declaration for the `String` data type.

- Source: Generated code
- Type last changed: v2.93.0 · 23 Aug 2023

## 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

- `defaultValues`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnAnalysis.StringDefaultValuesProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_quicksight.CfnAnalysis.StringDefaultValuesProperty.html) — The default values of a parameter.

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

- `mappedDataSetParameters`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnAnalysis.MappedDataSetParameterProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_quicksight.CfnAnalysis.MappedDataSetParameterProperty.html)[]

- `name`: string (required) — The name of the parameter that is being declared.

- `parameterValueType`: string (required) — The value type determines whether the parameter is a single-value or multi-value parameter.

- `valueWhenUnset`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnAnalysis.StringValueWhenUnsetConfigurationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_quicksight.CfnAnalysis.StringValueWhenUnsetConfigurationProperty.html) — The configuration that defines the default value of a `String` parameter when a value has not been set.