interface StringParameterDeclarationProperty

Language	Type name
.NET	`Amazon.CDK.Mixins.Preview.AWS.QuickSight.Mixins.CfnAnalysisPropsMixin.StringParameterDeclarationProperty`
Go	`github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsquicksight/mixins#CfnAnalysisPropsMixin_StringParameterDeclarationProperty`
Java	`software.amazon.awscdk.mixins.preview.services.quicksight.mixins.CfnAnalysisPropsMixin.StringParameterDeclarationProperty`
Python	`aws_cdk.mixins_preview.aws_quicksight.mixins.CfnAnalysisPropsMixin.StringParameterDeclarationProperty`
TypeScript	`@aws-cdk/mixins-preview` » `aws_quicksight` » `mixins` » `CfnAnalysisPropsMixin` » `StringParameterDeclarationProperty`

A parameter declaration for the String data type.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as quicksight_mixins } from '@aws-cdk/mixins-preview/aws-quicksight';
const stringParameterDeclarationProperty: quicksight_mixins.CfnAnalysisPropsMixin.StringParameterDeclarationProperty = {
  defaultValues: {
    dynamicValue: {
      defaultValueColumn: {
        columnName: 'columnName',
        dataSetIdentifier: 'dataSetIdentifier',
      },
      groupNameColumn: {
        columnName: 'columnName',
        dataSetIdentifier: 'dataSetIdentifier',
      },
      userNameColumn: {
        columnName: 'columnName',
        dataSetIdentifier: 'dataSetIdentifier',
      },
    },
    staticValues: ['staticValues'],
  },
  mappedDataSetParameters: [{
    dataSetIdentifier: 'dataSetIdentifier',
    dataSetParameterName: 'dataSetParameterName',
  }],
  name: 'name',
  parameterValueType: 'parameterValueType',
  valueWhenUnset: {
    customValue: 'customValue',
    valueWhenUnsetOption: 'valueWhenUnsetOption',
  },
};

Properties

Name	Type	Description
defaultValues?	`IResolvable` `\|` `StringDefaultValuesProperty`	The default values of a parameter.
mappedDataSetParameters?	`IResolvable` `\| (IResolvable` `\|` `MappedDataSetParameterProperty)[]`
name?	`string`	The name of the parameter that is being declared.
parameterValueType?	`string`	The value type determines whether the parameter is a single-value or multi-value parameter.
valueWhenUnset?	`IResolvable` `\|` `StringValueWhenUnsetConfigurationProperty`	The configuration that defines the default value of a `String` parameter when a value has not been set.

defaultValues?

Type: IResolvable | StringDefaultValuesProperty (optional)

The default values of a parameter.

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

mappedDataSetParameters?

Type: IResolvable | (IResolvable | MappedDataSetParameterProperty)[] (optional)

name?

Type: string (optional)

The name of the parameter that is being declared.

parameterValueType?

Type: string (optional)

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

valueWhenUnset?

Type: IResolvable | StringValueWhenUnsetConfigurationProperty (optional)

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

AWS CDK

2.233.0