Package software.amazon.awscdk.services.quicksight

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();

  • Method Details

    • getName

      @Stability(Stable) @NotNull String getName()
      The name of the parameter that is being declared.

    • getParameterValueType

      @Stability(Stable) @NotNull String getParameterValueType()
      The value type determines whether the parameter is a single-value or multi-value parameter.

    • getDefaultValues

      @Stability(Stable) @Nullable default Object 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

      @Stability(Stable) @Nullable default Object getMappedDataSetParameters()
      CfnTemplate.StringParameterDeclarationProperty.MappedDataSetParameters.

    • getValueWhenUnset

      @Stability(Stable) @Nullable default Object getValueWhenUnset()
      The configuration that defines the default value of a String parameter when a value has not been set.

    • builder

      @Stability(Stable) static CfnTemplate.StringParameterDeclarationProperty.Builder builder()
      Returns:
      a CfnTemplate.StringParameterDeclarationProperty.Builder of CfnTemplate.StringParameterDeclarationProperty