Package software.amazon.awscdk.services.quicksight

Interface CfnDashboard.DateTimeParameterDeclarationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDashboard.DateTimeParameterDeclarationProperty.Jsii$Proxy

Enclosing class:

CfnDashboard

@Stability(Stable)
public static interface CfnDashboard.DateTimeParameterDeclarationProperty
extends software.amazon.jsii.JsiiSerializable

A parameter declaration for the DateTime 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.*;
 DateTimeParameterDeclarationProperty dateTimeParameterDeclarationProperty = 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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datetimeparameterdeclaration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDashboard.DateTimeParameterDeclarationProperty.Builder	A builder for CfnDashboard.DateTimeParameterDeclarationProperty
static final class	CfnDashboard.DateTimeParameterDeclarationProperty.Jsii$Proxy	An implementation for CfnDashboard.DateTimeParameterDeclarationProperty

Method Summary

Modifier and Type	Method	Description
static CfnDashboard.DateTimeParameterDeclarationProperty.Builder	builder()
default Object	getDefaultValues()	The default values of a parameter.
default Object	getMappedDataSetParameters()
String	getName()	The name of the parameter that is being declared.
default String	getTimeGranularity()	The level of time precision that is used to aggregate DateTime values.
default Object	getValueWhenUnset()	The configuration that defines the default value of a DateTime parameter when a value has not been set.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name of the parameter that is being declared.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datetimeparameterdeclaration.html#cfn-quicksight-dashboard-datetimeparameterdeclaration-name

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datetimeparameterdeclaration.html#cfn-quicksight-dashboard-datetimeparameterdeclaration-defaultvalues

getMappedDataSetParameters

@Stability(Stable)
@Nullable
default Object getMappedDataSetParameters()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datetimeparameterdeclaration.html#cfn-quicksight-dashboard-datetimeparameterdeclaration-mappeddatasetparameters

getTimeGranularity

@Stability(Stable)
@Nullable
default String getTimeGranularity()

The level of time precision that is used to aggregate DateTime values.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datetimeparameterdeclaration.html#cfn-quicksight-dashboard-datetimeparameterdeclaration-timegranularity

getValueWhenUnset

@Stability(Stable)
@Nullable
default Object getValueWhenUnset()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datetimeparameterdeclaration.html#cfn-quicksight-dashboard-datetimeparameterdeclaration-valuewhenunset

builder

@Stability(Stable)
static CfnDashboard.DateTimeParameterDeclarationProperty.Builder builder()

Returns:

a CfnDashboard.DateTimeParameterDeclarationProperty.Builder of CfnDashboard.DateTimeParameterDeclarationProperty