cloudshift.awscdk.dsl.services.quicksight.CfnDashboardDateDimensionFieldPropertyDsl.kt Maven / Gradle / Ivy
@file:Suppress("RedundantVisibilityModifier", "RedundantUnitReturnType", "RemoveRedundantQualifierName", "unused", "UnusedImport", "ClassName", "REDUNDANT_PROJECTION", "DEPRECATION")
package cloudshift.awscdk.dsl.services.quicksight
import cloudshift.awscdk.common.CdkDslMarker
import software.amazon.awscdk.IResolvable
import software.amazon.awscdk.services.quicksight.CfnDashboard
import kotlin.String
/**
* The dimension type field with date type columns.
*
* 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.*;
* DateDimensionFieldProperty dateDimensionFieldProperty = DateDimensionFieldProperty.builder()
* .column(ColumnIdentifierProperty.builder()
* .columnName("columnName")
* .dataSetIdentifier("dataSetIdentifier")
* .build())
* .fieldId("fieldId")
* // the properties below are optional
* .dateGranularity("dateGranularity")
* .formatConfiguration(DateTimeFormatConfigurationProperty.builder()
* .dateTimeFormat("dateTimeFormat")
* .nullValueFormatConfiguration(NullValueFormatConfigurationProperty.builder()
* .nullString("nullString")
* .build())
* .numericFormatConfiguration(NumericFormatConfigurationProperty.builder()
* .currencyDisplayFormatConfiguration(CurrencyDisplayFormatConfigurationProperty.builder()
* .decimalPlacesConfiguration(DecimalPlacesConfigurationProperty.builder()
* .decimalPlaces(123)
* .build())
* .negativeValueConfiguration(NegativeValueConfigurationProperty.builder()
* .displayMode("displayMode")
* .build())
* .nullValueFormatConfiguration(NullValueFormatConfigurationProperty.builder()
* .nullString("nullString")
* .build())
* .numberScale("numberScale")
* .prefix("prefix")
* .separatorConfiguration(NumericSeparatorConfigurationProperty.builder()
* .decimalSeparator("decimalSeparator")
* .thousandsSeparator(ThousandSeparatorOptionsProperty.builder()
* .symbol("symbol")
* .visibility("visibility")
* .build())
* .build())
* .suffix("suffix")
* .symbol("symbol")
* .build())
* .numberDisplayFormatConfiguration(NumberDisplayFormatConfigurationProperty.builder()
* .decimalPlacesConfiguration(DecimalPlacesConfigurationProperty.builder()
* .decimalPlaces(123)
* .build())
* .negativeValueConfiguration(NegativeValueConfigurationProperty.builder()
* .displayMode("displayMode")
* .build())
* .nullValueFormatConfiguration(NullValueFormatConfigurationProperty.builder()
* .nullString("nullString")
* .build())
* .numberScale("numberScale")
* .prefix("prefix")
* .separatorConfiguration(NumericSeparatorConfigurationProperty.builder()
* .decimalSeparator("decimalSeparator")
* .thousandsSeparator(ThousandSeparatorOptionsProperty.builder()
* .symbol("symbol")
* .visibility("visibility")
* .build())
* .build())
* .suffix("suffix")
* .build())
* .percentageDisplayFormatConfiguration(PercentageDisplayFormatConfigurationProperty.builder()
* .decimalPlacesConfiguration(DecimalPlacesConfigurationProperty.builder()
* .decimalPlaces(123)
* .build())
* .negativeValueConfiguration(NegativeValueConfigurationProperty.builder()
* .displayMode("displayMode")
* .build())
* .nullValueFormatConfiguration(NullValueFormatConfigurationProperty.builder()
* .nullString("nullString")
* .build())
* .prefix("prefix")
* .separatorConfiguration(NumericSeparatorConfigurationProperty.builder()
* .decimalSeparator("decimalSeparator")
* .thousandsSeparator(ThousandSeparatorOptionsProperty.builder()
* .symbol("symbol")
* .visibility("visibility")
* .build())
* .build())
* .suffix("suffix")
* .build())
* .build())
* .build())
* .hierarchyId("hierarchyId")
* .build();
* ```
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datedimensionfield.html)
*/
@CdkDslMarker
public class CfnDashboardDateDimensionFieldPropertyDsl {
private val cdkBuilder: CfnDashboard.DateDimensionFieldProperty.Builder =
CfnDashboard.DateDimensionFieldProperty.builder()
/**
* @param column The column that is used in the `DateDimensionField` .
*/
public fun column(column: IResolvable) {
cdkBuilder.column(column)
}
/**
* @param column The column that is used in the `DateDimensionField` .
*/
public fun column(column: CfnDashboard.ColumnIdentifierProperty) {
cdkBuilder.column(column)
}
/**
* @param dateGranularity The date granularity of the `DateDimensionField` . Choose one of the
* following options:.
* * `YEAR`
* * `QUARTER`
* * `MONTH`
* * `WEEK`
* * `DAY`
* * `HOUR`
* * `MINUTE`
* * `SECOND`
* * `MILLISECOND`
*/
public fun dateGranularity(dateGranularity: String) {
cdkBuilder.dateGranularity(dateGranularity)
}
/**
* @param fieldId The custom field ID.
*/
public fun fieldId(fieldId: String) {
cdkBuilder.fieldId(fieldId)
}
/**
* @param formatConfiguration The format configuration of the field.
*/
public fun formatConfiguration(formatConfiguration: IResolvable) {
cdkBuilder.formatConfiguration(formatConfiguration)
}
/**
* @param formatConfiguration The format configuration of the field.
*/
public fun formatConfiguration(formatConfiguration: CfnDashboard.DateTimeFormatConfigurationProperty) {
cdkBuilder.formatConfiguration(formatConfiguration)
}
/**
* @param hierarchyId The custom hierarchy ID.
*/
public fun hierarchyId(hierarchyId: String) {
cdkBuilder.hierarchyId(hierarchyId)
}
public fun build(): CfnDashboard.DateDimensionFieldProperty = cdkBuilder.build()
}