aws-cdk-lib.aws_quicksight.CfnDashboard.ParameterTextFieldControlProperty

interface ParameterTextFieldControlProperty

LanguageType name
.NETAmazon.CDK.AWS.QuickSight.CfnDashboard.ParameterTextFieldControlProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnDashboard_ParameterTextFieldControlProperty
Javasoftware.amazon.awscdk.services.quicksight.CfnDashboard.ParameterTextFieldControlProperty
Pythonaws_cdk.aws_quicksight.CfnDashboard.ParameterTextFieldControlProperty
TypeScript aws-cdk-lib » aws_quicksight » CfnDashboard » ParameterTextFieldControlProperty

A control to display a text box that is used to enter a single entry.

Example

// 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 parameterTextFieldControlProperty: quicksight.CfnDashboard.ParameterTextFieldControlProperty = {
  parameterControlId: 'parameterControlId',
  sourceParameterName: 'sourceParameterName',
  title: 'title',

  // the properties below are optional
  displayOptions: {
    placeholderOptions: {
      visibility: 'visibility',
    },
    titleOptions: {
      customLabel: 'customLabel',
      fontConfiguration: {
        fontColor: 'fontColor',
        fontDecoration: 'fontDecoration',
        fontSize: {
          relative: 'relative',
        },
        fontStyle: 'fontStyle',
        fontWeight: {
          name: 'name',
        },
      },
      visibility: 'visibility',
    },
  },
};

Properties

NameTypeDescription
parameterControlIdstringThe ID of the ParameterTextFieldControl .
sourceParameterNamestringThe source parameter name of the ParameterTextFieldControl .
titlestringThe title of the ParameterTextFieldControl .
displayOptions?IResolvable | TextFieldControlDisplayOptionsPropertyThe display options of a control.

parameterControlId

Type: string

The ID of the ParameterTextFieldControl .


sourceParameterName

Type: string

The source parameter name of the ParameterTextFieldControl .


title

Type: string

The title of the ParameterTextFieldControl .


displayOptions?

Type: IResolvable | TextFieldControlDisplayOptionsProperty (optional)

The display options of a control.