AWS::QuickSight::Template StringParameterDeclaration

Filter View

All

A parameter declaration for the String data type.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "DefaultValues" : StringDefaultValues,
  "MappedDataSetParameters" : [ MappedDataSetParameter, ... ],
  "Name" : String,
  "ParameterValueType" : String,
  "ValueWhenUnset" : StringValueWhenUnsetConfiguration
}

YAML

  DefaultValues: 
    StringDefaultValues
  MappedDataSetParameters: 
    - MappedDataSetParameter
  Name: String
  ParameterValueType: String
  ValueWhenUnset: 
    StringValueWhenUnsetConfiguration

Properties

DefaultValues

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

Required: No

Type: StringDefaultValues

Update requires: No interruption

MappedDataSetParameters

Property description not available.

Required: No

Type: Array of MappedDataSetParameter

Minimum: 0

Maximum: 150

Update requires: No interruption

Name

The name of the parameter that is being declared.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9]+$

Minimum: 1

Maximum: 2048

Update requires: No interruption

ParameterValueType

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

Required: Yes

Type: String

Allowed values: MULTI_VALUED | SINGLE_VALUED

Update requires: No interruption

ValueWhenUnset

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

Required: No

Type: StringValueWhenUnsetConfiguration

Update requires: No interruption