Class CfnDataSet

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
All Implemented Interfaces:
IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.99.0 (build 8f757e4)", date="2024-06-13T18:49:23.612Z") @Stability(Stable) public class CfnDataSet extends CfnResource implements IInspectable, ITaggable
Creates a dataset.

This operation doesn't support datasets that include uploaded files as a source.

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;
 CfnDataSet cfnDataSet = CfnDataSet.Builder.create(this, "MyCfnDataSet")
         .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:
  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.
  • Constructor Details

    • CfnDataSet

      protected CfnDataSet(software.amazon.jsii.JsiiObjectRef objRef)
    • CfnDataSet

      protected CfnDataSet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
    • CfnDataSet

      @Stability(Stable) public CfnDataSet(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnDataSetProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.
    • CfnDataSet

      @Stability(Stable) public CfnDataSet(@NotNull software.constructs.Construct scope, @NotNull String id)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.
    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.
    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the dataset.
    • getAttrConsumedSpiceCapacityInBytes

      @Stability(Stable) @NotNull public IResolvable getAttrConsumedSpiceCapacityInBytes()

      The amount of SPICE capacity used by this dataset.

      This is 0 if the dataset isn't imported into SPICE.

    • getAttrCreatedTime

      @Stability(Stable) @NotNull public String getAttrCreatedTime()
      The time this dataset version was created.
    • getAttrLastUpdatedTime

      @Stability(Stable) @NotNull public String getAttrLastUpdatedTime()
      The time this dataset version was last updated.
    • getAttrOutputColumns

      @Stability(Stable) @NotNull public IResolvable getAttrOutputColumns()

      The list of columns after all transforms.

      These columns are available in templates, analyses, and dashboards.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource
    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable
    • getAwsAccountId

      @Stability(Stable) @Nullable public String getAwsAccountId()
      The AWS account ID.
    • setAwsAccountId

      @Stability(Stable) public void setAwsAccountId(@Nullable String value)
      The AWS account ID.
    • getColumnGroups

      @Stability(Stable) @Nullable public Object getColumnGroups()
      Groupings of columns that work together in certain Amazon QuickSight features.
    • setColumnGroups

      @Stability(Stable) public void setColumnGroups(@Nullable IResolvable value)
      Groupings of columns that work together in certain Amazon QuickSight features.
    • setColumnGroups

      @Stability(Stable) public void setColumnGroups(@Nullable List<Object> value)
      Groupings of columns that work together in certain Amazon QuickSight features.
    • getColumnLevelPermissionRules

      @Stability(Stable) @Nullable public Object getColumnLevelPermissionRules()
      A set of one or more definitions of a ColumnLevelPermissionRule .
    • setColumnLevelPermissionRules

      @Stability(Stable) public void setColumnLevelPermissionRules(@Nullable IResolvable value)
      A set of one or more definitions of a ColumnLevelPermissionRule .
    • setColumnLevelPermissionRules

      @Stability(Stable) public void setColumnLevelPermissionRules(@Nullable List<Object> value)
      A set of one or more definitions of a ColumnLevelPermissionRule .
    • getDataSetId

      @Stability(Stable) @Nullable public String getDataSetId()
      An ID for the dataset that you want to create.
    • setDataSetId

      @Stability(Stable) public void setDataSetId(@Nullable String value)
      An ID for the dataset that you want to create.
    • getDatasetParameters

      @Stability(Stable) @Nullable public Object getDatasetParameters()
      The parameters that are declared in a dataset.
    • setDatasetParameters

      @Stability(Stable) public void setDatasetParameters(@Nullable IResolvable value)
      The parameters that are declared in a dataset.
    • setDatasetParameters

      @Stability(Stable) public void setDatasetParameters(@Nullable List<Object> value)
      The parameters that are declared in a dataset.
    • getDataSetRefreshProperties

      @Stability(Stable) @Nullable public Object getDataSetRefreshProperties()
      The refresh properties of a dataset.
    • setDataSetRefreshProperties

      @Stability(Stable) public void setDataSetRefreshProperties(@Nullable IResolvable value)
      The refresh properties of a dataset.
    • setDataSetRefreshProperties

      @Stability(Stable) public void setDataSetRefreshProperties(@Nullable CfnDataSet.DataSetRefreshPropertiesProperty value)
      The refresh properties of a dataset.
    • getDataSetUsageConfiguration

      @Stability(Stable) @Nullable public Object getDataSetUsageConfiguration()
      The usage configuration to apply to child datasets that reference this dataset as a source.
    • setDataSetUsageConfiguration

      @Stability(Stable) public void setDataSetUsageConfiguration(@Nullable IResolvable value)
      The usage configuration to apply to child datasets that reference this dataset as a source.
    • setDataSetUsageConfiguration

      @Stability(Stable) public void setDataSetUsageConfiguration(@Nullable CfnDataSet.DataSetUsageConfigurationProperty value)
      The usage configuration to apply to child datasets that reference this dataset as a source.
    • getFieldFolders

      @Stability(Stable) @Nullable public Object getFieldFolders()
      The folder that contains fields and nested subfolders for your dataset.
    • setFieldFolders

      @Stability(Stable) public void setFieldFolders(@Nullable IResolvable value)
      The folder that contains fields and nested subfolders for your dataset.
    • setFieldFolders

      @Stability(Stable) public void setFieldFolders(@Nullable Map<String,Object> value)
      The folder that contains fields and nested subfolders for your dataset.
    • getImportMode

      @Stability(Stable) @Nullable public String getImportMode()
      Indicates whether you want to import the data into SPICE.
    • setImportMode

      @Stability(Stable) public void setImportMode(@Nullable String value)
      Indicates whether you want to import the data into SPICE.
    • getIngestionWaitPolicy

      @Stability(Stable) @Nullable public Object getIngestionWaitPolicy()
      The wait policy to use when creating or updating a Dataset.
    • setIngestionWaitPolicy

      @Stability(Stable) public void setIngestionWaitPolicy(@Nullable IResolvable value)
      The wait policy to use when creating or updating a Dataset.
    • setIngestionWaitPolicy

      @Stability(Stable) public void setIngestionWaitPolicy(@Nullable CfnDataSet.IngestionWaitPolicyProperty value)
      The wait policy to use when creating or updating a Dataset.
    • getLogicalTableMap

      @Stability(Stable) @Nullable public Object getLogicalTableMap()
      Configures the combination and transformation of the data from the physical tables.
    • setLogicalTableMap

      @Stability(Stable) public void setLogicalTableMap(@Nullable IResolvable value)
      Configures the combination and transformation of the data from the physical tables.
    • setLogicalTableMap

      @Stability(Stable) public void setLogicalTableMap(@Nullable Map<String,Object> value)
      Configures the combination and transformation of the data from the physical tables.
    • getName

      @Stability(Stable) @Nullable public String getName()
      The display name for the dataset.
    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The display name for the dataset.
    • getPermissions

      @Stability(Stable) @Nullable public Object getPermissions()
      A list of resource permissions on the dataset.
    • setPermissions

      @Stability(Stable) public void setPermissions(@Nullable IResolvable value)
      A list of resource permissions on the dataset.
    • setPermissions

      @Stability(Stable) public void setPermissions(@Nullable List<Object> value)
      A list of resource permissions on the dataset.
    • getPhysicalTableMap

      @Stability(Stable) @Nullable public Object getPhysicalTableMap()
      Declares the physical tables that are available in the underlying data sources.
    • setPhysicalTableMap

      @Stability(Stable) public void setPhysicalTableMap(@Nullable IResolvable value)
      Declares the physical tables that are available in the underlying data sources.
    • setPhysicalTableMap

      @Stability(Stable) public void setPhysicalTableMap(@Nullable Map<String,Object> value)
      Declares the physical tables that are available in the underlying data sources.
    • getRowLevelPermissionDataSet

      @Stability(Stable) @Nullable public Object getRowLevelPermissionDataSet()
      The row-level security configuration for the data that you want to create.
    • setRowLevelPermissionDataSet

      @Stability(Stable) public void setRowLevelPermissionDataSet(@Nullable IResolvable value)
      The row-level security configuration for the data that you want to create.
    • setRowLevelPermissionDataSet

      @Stability(Stable) public void setRowLevelPermissionDataSet(@Nullable CfnDataSet.RowLevelPermissionDataSetProperty value)
      The row-level security configuration for the data that you want to create.
    • getRowLevelPermissionTagConfiguration

      @Stability(Stable) @Nullable public Object getRowLevelPermissionTagConfiguration()
      The element you can use to define tags for row-level security.
    • setRowLevelPermissionTagConfiguration

      @Stability(Stable) public void setRowLevelPermissionTagConfiguration(@Nullable IResolvable value)
      The element you can use to define tags for row-level security.
    • setRowLevelPermissionTagConfiguration

      @Stability(Stable) public void setRowLevelPermissionTagConfiguration(@Nullable CfnDataSet.RowLevelPermissionTagConfigurationProperty value)
      The element you can use to define tags for row-level security.
    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.
    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.