All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnDataSetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-22T02:24:06.902Z") @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()))
         .folderArns(List.of("folderArns"))
         .importMode("importMode")
         .ingestionWaitPolicy(IngestionWaitPolicyProperty.builder()
                 .ingestionWaitTimeInHours(123)
                 .waitForSpiceIngestion(false)
                 .build())
         .logicalTableMap(Map.of(
                 "logicalTableMapKey", LogicalTableProperty.builder()
                         .alias("alias")
                         // 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()))
                         .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())
                         .build()))
         .name("name")
         .permissions(List.of(ResourcePermissionProperty.builder()
                 .actions(List.of("actions"))
                 .principal("principal")
                 .build()))
         .physicalTableMap(Map.of(
                 "physicalTableMapKey", PhysicalTableProperty.builder()
                         .customSql(CustomSqlProperty.builder()
                                 .dataSourceArn("dataSourceArn")
                                 .name("name")
                                 .sqlQuery("sqlQuery")
                                 // the properties below are optional
                                 .columns(List.of(InputColumnProperty.builder()
                                         .name("name")
                                         .type("type")
                                         // the properties below are optional
                                         .subType("subType")
                                         .build()))
                                 .build())
                         .relationalTable(RelationalTableProperty.builder()
                                 .dataSourceArn("dataSourceArn")
                                 .name("name")
                                 // the properties below are optional
                                 .catalog("catalog")
                                 .inputColumns(List.of(InputColumnProperty.builder()
                                         .name("name")
                                         .type("type")
                                         // the properties below are optional
                                         .subType("subType")
                                         .build()))
                                 .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:

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static final class

CfnDataSetProps.Builder

A builder for CfnDataSetProps

static final class

CfnDataSetProps.Jsii$Proxy

An implementation for CfnDataSetProps
Method Summary

Modifier and Type

Method

Description

static CfnDataSetProps.Builder

builder()

default String

getAwsAccountId()

The AWS account ID.

default Object

getColumnGroups()

Groupings of columns that work together in certain Amazon QuickSight features.

default Object

getColumnLevelPermissionRules()

A set of one or more definitions of a ColumnLevelPermissionRule .

default String

getDataSetId()

An ID for the dataset that you want to create.

default Object

getDatasetParameters()

The parameters that are declared in a dataset.

default Object

getDataSetRefreshProperties()

The refresh properties of a dataset.

default Object

getDataSetUsageConfiguration()

The usage configuration to apply to child datasets that reference this dataset as a source.

default Object

getFieldFolders()

The folder that contains fields and nested subfolders for your dataset.

default List<String>

getFolderArns()

When you create the dataset, Amazon QuickSight adds the dataset to these folders.

default String

getImportMode()

Indicates whether you want to import the data into SPICE.

default Object

getIngestionWaitPolicy()

The wait policy to use when creating or updating a Dataset.

default Object

getLogicalTableMap()

Configures the combination and transformation of the data from the physical tables.

default String

getName()

The display name for the dataset.

default Object

getPermissions()

A list of resource permissions on the dataset.

default Object

getPhysicalTableMap()

Declares the physical tables that are available in the underlying data sources.

default Object

getRowLevelPermissionDataSet()

The row-level security configuration for the data that you want to create.

default Object

getRowLevelPermissionTagConfiguration()

The element you can use to define tags for row-level security.

default List<CfnTag>

getTags()

Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

Method Details
- getAwsAccountId
  
  @Stability(Stable) @Nullable default String getAwsAccountId()
  
  The AWS account ID.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-awsaccountid
- getColumnGroups
  
  @Stability(Stable) @Nullable default Object getColumnGroups()
  
  Groupings of columns that work together in certain Amazon QuickSight features.
  Currently, only geospatial hierarchy is supported.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-columngroups
- getColumnLevelPermissionRules
  
  @Stability(Stable) @Nullable default Object getColumnLevelPermissionRules()
  
  A set of one or more definitions of a ColumnLevelPermissionRule .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-columnlevelpermissionrules
- getDataSetId
  
  @Stability(Stable) @Nullable default String getDataSetId()
  
  An ID for the dataset that you want to create.
  This ID is unique per AWS Region for each AWS account.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-datasetid
- getDatasetParameters
  
  @Stability(Stable) @Nullable default Object getDatasetParameters()
  
  The parameters that are declared in a dataset.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-datasetparameters
- getDataSetRefreshProperties
  
  @Stability(Stable) @Nullable default Object getDataSetRefreshProperties()
  
  The refresh properties of a dataset.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-datasetrefreshproperties
- getDataSetUsageConfiguration
  
  @Stability(Stable) @Nullable default Object getDataSetUsageConfiguration()
  
  The usage configuration to apply to child datasets that reference this dataset as a source.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-datasetusageconfiguration
- getFieldFolders
  
  @Stability(Stable) @Nullable default Object getFieldFolders()
  
  The folder that contains fields and nested subfolders for your dataset.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-fieldfolders
- getFolderArns
  
  @Stability(Stable) @Nullable default List<String> getFolderArns()
  
  When you create the dataset, Amazon QuickSight adds the dataset to these folders.
  .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-folderarns
- getImportMode
  
  @Stability(Stable) @Nullable default String getImportMode()
  
  Indicates whether you want to import the data into SPICE.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-importmode
- getIngestionWaitPolicy
  
  @Stability(Stable) @Nullable default Object getIngestionWaitPolicy()
  
  The wait policy to use when creating or updating a Dataset.
  The default is to wait for SPICE ingestion to finish with timeout of 36 hours.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-ingestionwaitpolicy
- getLogicalTableMap
  
  @Stability(Stable) @Nullable default Object getLogicalTableMap()
  
  Configures the combination and transformation of the data from the physical tables.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-logicaltablemap
- getName
  
  @Stability(Stable) @Nullable default String getName()
  
  The display name for the dataset.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-name
- getPermissions
  
  @Stability(Stable) @Nullable default Object getPermissions()
  
  A list of resource permissions on the dataset.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-permissions
- getPhysicalTableMap
  
  @Stability(Stable) @Nullable default Object getPhysicalTableMap()
  
  Declares the physical tables that are available in the underlying data sources.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-physicaltablemap
- getRowLevelPermissionDataSet
  
  @Stability(Stable) @Nullable default Object getRowLevelPermissionDataSet()
  
  The row-level security configuration for the data that you want to create.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-rowlevelpermissiondataset
- getRowLevelPermissionTagConfiguration
  
  @Stability(Stable) @Nullable default Object getRowLevelPermissionTagConfiguration()
  
  The element you can use to define tags for row-level security.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-rowlevelpermissiontagconfiguration
- getTags
  
  @Stability(Stable) @Nullable default List<CfnTag> getTags()
  
  Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-tags
- builder
  
  @Stability(Stable) static CfnDataSetProps.Builder builder()
  
  Returns:
  
  a CfnDataSetProps.Builder of CfnDataSetProps

Interface CfnDataSetProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Details

getAwsAccountId

getColumnGroups

getColumnLevelPermissionRules

getDataSetId

getDatasetParameters

getDataSetRefreshProperties

getDataSetUsageConfiguration

getFieldFolders

getFolderArns

getImportMode

getIngestionWaitPolicy

getLogicalTableMap

getName

getPermissions

getPhysicalTableMap

getRowLevelPermissionDataSet

getRowLevelPermissionTagConfiguration

getTags

builder