Interface CfnTemplate.StringParameterDeclarationProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnTemplate.StringParameterDeclarationProperty.Jsii$Proxy
- Enclosing class:
CfnTemplate
@Stability(Stable)
public static interface CfnTemplate.StringParameterDeclarationProperty
extends software.amazon.jsii.JsiiSerializable
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 software.amazon.awscdk.services.quicksight.*; StringParameterDeclarationProperty stringParameterDeclarationProperty = StringParameterDeclarationProperty.builder() .name("name") .parameterValueType("parameterValueType") // the properties below are optional .defaultValues(StringDefaultValuesProperty.builder() .dynamicValue(DynamicDefaultValueProperty.builder() .defaultValueColumn(ColumnIdentifierProperty.builder() .columnName("columnName") .dataSetIdentifier("dataSetIdentifier") .build()) // the properties below are optional .groupNameColumn(ColumnIdentifierProperty.builder() .columnName("columnName") .dataSetIdentifier("dataSetIdentifier") .build()) .userNameColumn(ColumnIdentifierProperty.builder() .columnName("columnName") .dataSetIdentifier("dataSetIdentifier") .build()) .build()) .staticValues(List.of("staticValues")) .build()) .mappedDataSetParameters(List.of(MappedDataSetParameterProperty.builder() .dataSetIdentifier("dataSetIdentifier") .dataSetParameterName("dataSetParameterName") .build())) .valueWhenUnset(StringValueWhenUnsetConfigurationProperty.builder() .customValue("customValue") .valueWhenUnsetOption("valueWhenUnsetOption") .build()) .build();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnTemplate.StringParameterDeclarationProperty
static final class
An implementation forCfnTemplate.StringParameterDeclarationProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Object
The default values of a parameter.default Object
CfnTemplate.StringParameterDeclarationProperty.MappedDataSetParameters
.getName()
The name of the parameter that is being declared.The value type determines whether the parameter is a single-value or multi-value parameter.default Object
The configuration that defines the default value of aString
parameter when a value has not been set.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getName
The name of the parameter that is being declared. -
getParameterValueType
The value type determines whether the parameter is a single-value or multi-value parameter. -
getDefaultValues
The default values of a parameter.If the parameter is a single-value parameter, a maximum of one default value can be provided.
-
getMappedDataSetParameters
CfnTemplate.StringParameterDeclarationProperty.MappedDataSetParameters
. -
getValueWhenUnset
The configuration that defines the default value of aString
parameter when a value has not been set. -
builder
-