Interface CfnTemplate.ParameterDeclarationProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnTemplate.ParameterDeclarationProperty.Jsii$Proxy
- Enclosing class:
CfnTemplate
@Stability(Stable)
public static interface CfnTemplate.ParameterDeclarationProperty
extends software.amazon.jsii.JsiiSerializable
The declaration definition of a parameter.
For more information, see Parameters in Amazon QuickSight in the Amazon QuickSight User Guide .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
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.*; ParameterDeclarationProperty parameterDeclarationProperty = ParameterDeclarationProperty.builder() .dateTimeParameterDeclaration(DateTimeParameterDeclarationProperty.builder() .name("name") // the properties below are optional .defaultValues(DateTimeDefaultValuesProperty.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()) .rollingDate(RollingDateConfigurationProperty.builder() .expression("expression") // the properties below are optional .dataSetIdentifier("dataSetIdentifier") .build()) .staticValues(List.of("staticValues")) .build()) .mappedDataSetParameters(List.of(MappedDataSetParameterProperty.builder() .dataSetIdentifier("dataSetIdentifier") .dataSetParameterName("dataSetParameterName") .build())) .timeGranularity("timeGranularity") .valueWhenUnset(DateTimeValueWhenUnsetConfigurationProperty.builder() .customValue("customValue") .valueWhenUnsetOption("valueWhenUnsetOption") .build()) .build()) .decimalParameterDeclaration(DecimalParameterDeclarationProperty.builder() .name("name") .parameterValueType("parameterValueType") // the properties below are optional .defaultValues(DecimalDefaultValuesProperty.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(123)) .build()) .mappedDataSetParameters(List.of(MappedDataSetParameterProperty.builder() .dataSetIdentifier("dataSetIdentifier") .dataSetParameterName("dataSetParameterName") .build())) .valueWhenUnset(DecimalValueWhenUnsetConfigurationProperty.builder() .customValue(123) .valueWhenUnsetOption("valueWhenUnsetOption") .build()) .build()) .integerParameterDeclaration(IntegerParameterDeclarationProperty.builder() .name("name") .parameterValueType("parameterValueType") // the properties below are optional .defaultValues(IntegerDefaultValuesProperty.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(123)) .build()) .mappedDataSetParameters(List.of(MappedDataSetParameterProperty.builder() .dataSetIdentifier("dataSetIdentifier") .dataSetParameterName("dataSetParameterName") .build())) .valueWhenUnset(IntegerValueWhenUnsetConfigurationProperty.builder() .customValue(123) .valueWhenUnsetOption("valueWhenUnsetOption") .build()) .build()) .stringParameterDeclaration(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()) .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnTemplate.ParameterDeclarationProperty
static final class
An implementation forCfnTemplate.ParameterDeclarationProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Object
A parameter declaration for theDateTime
data type.default Object
A parameter declaration for theDecimal
data type.default Object
A parameter declaration for theInteger
data type.default Object
A parameter declaration for theString
data type.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getDateTimeParameterDeclaration
A parameter declaration for theDateTime
data type.- See Also:
-
getDecimalParameterDeclaration
A parameter declaration for theDecimal
data type.- See Also:
-
getIntegerParameterDeclaration
A parameter declaration for theInteger
data type.- See Also:
-
getStringParameterDeclaration
A parameter declaration for theString
data type.- See Also:
-
builder
-