Skip to content
v2.277.0

ParameterTextAreaControlProperty Struct ​

A control to display a text box that is used to enter multiple entries.

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 parameterTextAreaControlProperty: quicksight.CfnAnalysis.ParameterTextAreaControlProperty = {
  parameterControlId: 'parameterControlId',
  sourceParameterName: 'sourceParameterName',
  title: 'title',

  // the properties below are optional
  delimiter: 'delimiter',
  displayOptions: {
    infoIconLabelOptions: {
      infoIconText: 'infoIconText',
      visibility: 'visibility',
    },
    placeholderOptions: {
      visibility: 'visibility',
    },
    titleOptions: {
      customLabel: 'customLabel',
      fontConfiguration: {
        fontColor: 'fontColor',
        fontDecoration: 'fontDecoration',
        fontFamily: 'fontFamily',
        fontSize: {
          absolute: 'absolute',
          relative: 'relative',
        },
        fontStyle: 'fontStyle',
        fontWeight: {
          name: 'name',
        },
      },
      visibility: 'visibility',
    },
  },
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

parameter_text_area_control_property = quicksight.CfnAnalysis.ParameterTextAreaControlProperty(
    parameter_control_id="parameterControlId",
    source_parameter_name="sourceParameterName",
    title="title",

    # the properties below are optional
    delimiter="delimiter",
    display_options=quicksight.CfnAnalysis.TextAreaControlDisplayOptionsProperty(
        info_icon_label_options=quicksight.CfnAnalysis.SheetControlInfoIconLabelOptionsProperty(
            info_icon_text="infoIconText",
            visibility="visibility"
        ),
        placeholder_options=quicksight.CfnAnalysis.TextControlPlaceholderOptionsProperty(
            visibility="visibility"
        ),
        title_options=quicksight.CfnAnalysis.LabelOptionsProperty(
            custom_label="customLabel",
            font_configuration=quicksight.CfnAnalysis.FontConfigurationProperty(
                font_color="fontColor",
                font_decoration="fontDecoration",
                font_family="fontFamily",
                font_size=quicksight.CfnAnalysis.FontSizeProperty(
                    absolute="absolute",
                    relative="relative"
                ),
                font_style="fontStyle",
                font_weight=quicksight.CfnAnalysis.FontWeightProperty(
                    name="name"
                )
            ),
            visibility="visibility"
        )
    )
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.quicksight.*;

ParameterTextAreaControlProperty parameterTextAreaControlProperty = ParameterTextAreaControlProperty.builder()
        .parameterControlId("parameterControlId")
        .sourceParameterName("sourceParameterName")
        .title("title")

        // the properties below are optional
        .delimiter("delimiter")
        .displayOptions(TextAreaControlDisplayOptionsProperty.builder()
                .infoIconLabelOptions(SheetControlInfoIconLabelOptionsProperty.builder()
                        .infoIconText("infoIconText")
                        .visibility("visibility")
                        .build())
                .placeholderOptions(TextControlPlaceholderOptionsProperty.builder()
                        .visibility("visibility")
                        .build())
                .titleOptions(LabelOptionsProperty.builder()
                        .customLabel("customLabel")
                        .fontConfiguration(FontConfigurationProperty.builder()
                                .fontColor("fontColor")
                                .fontDecoration("fontDecoration")
                                .fontFamily("fontFamily")
                                .fontSize(FontSizeProperty.builder()
                                        .absolute("absolute")
                                        .relative("relative")
                                        .build())
                                .fontStyle("fontStyle")
                                .fontWeight(FontWeightProperty.builder()
                                        .name("name")
                                        .build())
                                .build())
                        .visibility("visibility")
                        .build())
                .build())
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// 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 parameterTextAreaControlProperty = new ParameterTextAreaControlProperty {
    ParameterControlId = "parameterControlId",
    SourceParameterName = "sourceParameterName",
    Title = "title",

    // the properties below are optional
    Delimiter = "delimiter",
    DisplayOptions = new TextAreaControlDisplayOptionsProperty {
        InfoIconLabelOptions = new SheetControlInfoIconLabelOptionsProperty {
            InfoIconText = "infoIconText",
            Visibility = "visibility"
        },
        PlaceholderOptions = new TextControlPlaceholderOptionsProperty {
            Visibility = "visibility"
        },
        TitleOptions = new LabelOptionsProperty {
            CustomLabel = "customLabel",
            FontConfiguration = new FontConfigurationProperty {
                FontColor = "fontColor",
                FontDecoration = "fontDecoration",
                FontFamily = "fontFamily",
                FontSize = new FontSizeProperty {
                    Absolute = "absolute",
                    Relative = "relative"
                },
                FontStyle = "fontStyle",
                FontWeight = new FontWeightProperty {
                    Name = "name"
                }
            },
            Visibility = "visibility"
        }
    }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

parameterTextAreaControlProperty := &ParameterTextAreaControlProperty{
	ParameterControlId: jsii.String("parameterControlId"),
	SourceParameterName: jsii.String("sourceParameterName"),
	Title: jsii.String("title"),

	// the properties below are optional
	Delimiter: jsii.String("delimiter"),
	DisplayOptions: &TextAreaControlDisplayOptionsProperty{
		InfoIconLabelOptions: &SheetControlInfoIconLabelOptionsProperty{
			InfoIconText: jsii.String("infoIconText"),
			Visibility: jsii.String("visibility"),
		},
		PlaceholderOptions: &TextControlPlaceholderOptionsProperty{
			Visibility: jsii.String("visibility"),
		},
		TitleOptions: &LabelOptionsProperty{
			CustomLabel: jsii.String("customLabel"),
			FontConfiguration: &FontConfigurationProperty{
				FontColor: jsii.String("fontColor"),
				FontDecoration: jsii.String("fontDecoration"),
				FontFamily: jsii.String("fontFamily"),
				FontSize: &FontSizeProperty{
					Absolute: jsii.String("absolute"),
					Relative: jsii.String("relative"),
				},
				FontStyle: jsii.String("fontStyle"),
				FontWeight: &FontWeightProperty{
					Name: jsii.String("name"),
				},
			},
			Visibility: jsii.String("visibility"),
		},
	},
}

Properties ​

delimiteroptionalstringdelimiteroptionalstrdelimiteroptionalStringDelimiteroptionalstringDelimiteroptional*string#
The delimiter that is used to separate the lines in text.
displayOptionsoptionalIResolvable | CfnAnalysis.TextAreaControlDisplayOptionsPropertydisplay_optionsoptionaltyping.Union[IResolvable, TextAreaControlDisplayOptionsProperty]displayOptionsoptionalIResolvableDisplayOptionsoptionalIResolvableDisplayOptionsoptionalinterface{}#
The display options of a control.
parameterControlIdstringparameter_control_idstrparameterControlIdStringParameterControlIdstringParameterControlId*stringrequired#
The ID of the `ParameterTextAreaControl` .
sourceParameterNamestringsource_parameter_namestrsourceParameterNameStringSourceParameterNamestringSourceParameterName*stringrequired#
The source parameter name of the `ParameterTextAreaControl` .
titlestringtitlestrtitleStringTitlestringTitle*stringrequired#
The title of the `ParameterTextAreaControl` .