Interface CfnDataSetProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnDataSetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)", date="2024-05-30T02:11:12.125Z") @Stability(Stable) public interface CfnDataSetProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnDataSet.

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.*;
 Object tagRuleConfigurations;
 CfnDataSetProps cfnDataSetProps = CfnDataSetProps.builder()
         .awsAccountId("awsAccountId")
         .columnGroups(List.of(ColumnGroupProperty.builder()
                 .geoSpatialColumnGroup(GeoSpatialColumnGroupProperty.builder()
                         .columns(List.of("columns"))
                         .name("name")
                         // the properties below are optional
                         .countryCode("countryCode")
                         .build())
                 .build()))
         .columnLevelPermissionRules(List.of(ColumnLevelPermissionRuleProperty.builder()
                 .columnNames(List.of("columnNames"))
                 .principals(List.of("principals"))
                 .build()))
         .dataSetId("dataSetId")
         .datasetParameters(List.of(DatasetParameterProperty.builder()
                 .dateTimeDatasetParameter(DateTimeDatasetParameterProperty.builder()
                         .id("id")
                         .name("name")
                         .valueType("valueType")
                         // the properties below are optional
                         .defaultValues(DateTimeDatasetParameterDefaultValuesProperty.builder()
                                 .staticValues(List.of("staticValues"))
                                 .build())
                         .timeGranularity("timeGranularity")
                         .build())
                 .decimalDatasetParameter(DecimalDatasetParameterProperty.builder()
                         .id("id")
                         .name("name")
                         .valueType("valueType")
                         // the properties below are optional
                         .defaultValues(DecimalDatasetParameterDefaultValuesProperty.builder()
                                 .staticValues(List.of(123))
                                 .build())
                         .build())
                 .integerDatasetParameter(IntegerDatasetParameterProperty.builder()
                         .id("id")
                         .name("name")
                         .valueType("valueType")
                         // the properties below are optional
                         .defaultValues(IntegerDatasetParameterDefaultValuesProperty.builder()
                                 .staticValues(List.of(123))
                                 .build())
                         .build())
                 .stringDatasetParameter(StringDatasetParameterProperty.builder()
                         .id("id")
                         .name("name")
                         .valueType("valueType")
                         // the properties below are optional
                         .defaultValues(StringDatasetParameterDefaultValuesProperty.builder()
                                 .staticValues(List.of("staticValues"))
                                 .build())
                         .build())
                 .build()))
         .dataSetRefreshProperties(DataSetRefreshPropertiesProperty.builder()
                 .refreshConfiguration(RefreshConfigurationProperty.builder()
                         .incrementalRefresh(IncrementalRefreshProperty.builder()
                                 .lookbackWindow(LookbackWindowProperty.builder()
                                         .columnName("columnName")
                                         .size(123)
                                         .sizeUnit("sizeUnit")
                                         .build())
                                 .build())
                         .build())
                 .build())
         .dataSetUsageConfiguration(DataSetUsageConfigurationProperty.builder()
                 .disableUseAsDirectQuerySource(false)
                 .disableUseAsImportedSource(false)
                 .build())
         .fieldFolders(Map.of(
                 "fieldFoldersKey", FieldFolderProperty.builder()
                         .columns(List.of("columns"))
                         .description("description")
                         .build()))
         .importMode("importMode")
         .ingestionWaitPolicy(IngestionWaitPolicyProperty.builder()
                 .ingestionWaitTimeInHours(123)
                 .waitForSpiceIngestion(false)
                 .build())
         .logicalTableMap(Map.of(
                 "logicalTableMapKey", LogicalTableProperty.builder()
                         .alias("alias")
                         .source(LogicalTableSourceProperty.builder()
                                 .dataSetArn("dataSetArn")
                                 .joinInstruction(JoinInstructionProperty.builder()
                                         .leftOperand("leftOperand")
                                         .onClause("onClause")
                                         .rightOperand("rightOperand")
                                         .type("type")
                                         // the properties below are optional
                                         .leftJoinKeyProperties(JoinKeyPropertiesProperty.builder()
                                                 .uniqueKey(false)
                                                 .build())
                                         .rightJoinKeyProperties(JoinKeyPropertiesProperty.builder()
                                                 .uniqueKey(false)
                                                 .build())
                                         .build())
                                 .physicalTableId("physicalTableId")
                                 .build())
                         // the properties below are optional
                         .dataTransforms(List.of(TransformOperationProperty.builder()
                                 .castColumnTypeOperation(CastColumnTypeOperationProperty.builder()
                                         .columnName("columnName")
                                         .newColumnType("newColumnType")
                                         // the properties below are optional
                                         .format("format")
                                         .subType("subType")
                                         .build())
                                 .createColumnsOperation(CreateColumnsOperationProperty.builder()
                                         .columns(List.of(CalculatedColumnProperty.builder()
                                                 .columnId("columnId")
                                                 .columnName("columnName")
                                                 .expression("expression")
                                                 .build()))
                                         .build())
                                 .filterOperation(FilterOperationProperty.builder()
                                         .conditionExpression("conditionExpression")
                                         .build())
                                 .overrideDatasetParameterOperation(OverrideDatasetParameterOperationProperty.builder()
                                         .parameterName("parameterName")
                                         // the properties below are optional
                                         .newDefaultValues(NewDefaultValuesProperty.builder()
                                                 .dateTimeStaticValues(List.of("dateTimeStaticValues"))
                                                 .decimalStaticValues(List.of(123))
                                                 .integerStaticValues(List.of(123))
                                                 .stringStaticValues(List.of("stringStaticValues"))
                                                 .build())
                                         .newParameterName("newParameterName")
                                         .build())
                                 .projectOperation(ProjectOperationProperty.builder()
                                         .projectedColumns(List.of("projectedColumns"))
                                         .build())
                                 .renameColumnOperation(RenameColumnOperationProperty.builder()
                                         .columnName("columnName")
                                         .newColumnName("newColumnName")
                                         .build())
                                 .tagColumnOperation(TagColumnOperationProperty.builder()
                                         .columnName("columnName")
                                         .tags(List.of(ColumnTagProperty.builder()
                                                 .columnDescription(ColumnDescriptionProperty.builder()
                                                         .text("text")
                                                         .build())
                                                 .columnGeographicRole("columnGeographicRole")
                                                 .build()))
                                         .build())
                                 .untagColumnOperation(UntagColumnOperationProperty.builder()
                                         .columnName("columnName")
                                         .tagNames(List.of("tagNames"))
                                         .build())
                                 .build()))
                         .build()))
         .name("name")
         .permissions(List.of(ResourcePermissionProperty.builder()
                 .actions(List.of("actions"))
                 .principal("principal")
                 .build()))
         .physicalTableMap(Map.of(
                 "physicalTableMapKey", PhysicalTableProperty.builder()
                         .customSql(CustomSqlProperty.builder()
                                 .columns(List.of(InputColumnProperty.builder()
                                         .name("name")
                                         .type("type")
                                         // the properties below are optional
                                         .subType("subType")
                                         .build()))
                                 .dataSourceArn("dataSourceArn")
                                 .name("name")
                                 .sqlQuery("sqlQuery")
                                 .build())
                         .relationalTable(RelationalTableProperty.builder()
                                 .dataSourceArn("dataSourceArn")
                                 .inputColumns(List.of(InputColumnProperty.builder()
                                         .name("name")
                                         .type("type")
                                         // the properties below are optional
                                         .subType("subType")
                                         .build()))
                                 .name("name")
                                 // the properties below are optional
                                 .catalog("catalog")
                                 .schema("schema")
                                 .build())
                         .s3Source(S3SourceProperty.builder()
                                 .dataSourceArn("dataSourceArn")
                                 .inputColumns(List.of(InputColumnProperty.builder()
                                         .name("name")
                                         .type("type")
                                         // the properties below are optional
                                         .subType("subType")
                                         .build()))
                                 // the properties below are optional
                                 .uploadSettings(UploadSettingsProperty.builder()
                                         .containsHeader(false)
                                         .delimiter("delimiter")
                                         .format("format")
                                         .startFromRow(123)
                                         .textQualifier("textQualifier")
                                         .build())
                                 .build())
                         .build()))
         .rowLevelPermissionDataSet(RowLevelPermissionDataSetProperty.builder()
                 .arn("arn")
                 .permissionPolicy("permissionPolicy")
                 // the properties below are optional
                 .formatVersion("formatVersion")
                 .namespace("namespace")
                 .status("status")
                 .build())
         .rowLevelPermissionTagConfiguration(RowLevelPermissionTagConfigurationProperty.builder()
                 .tagRules(List.of(RowLevelPermissionTagRuleProperty.builder()
                         .columnName("columnName")
                         .tagKey("tagKey")
                         // the properties below are optional
                         .matchAllValue("matchAllValue")
                         .tagMultiValueDelimiter("tagMultiValueDelimiter")
                         .build()))
                 // the properties below are optional
                 .status("status")
                 .tagRuleConfigurations(tagRuleConfigurations)
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also: