Class CfnDataSet
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.quicksight.CfnDataSet
- All Implemented Interfaces:
IInspectable
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-10-11T15:56:03.848Z")
@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())) .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() .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:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnDataSet
.static interface
A calculated column for a dataset.static interface
A transform operation that casts a column to a different type.static interface
Metadata that contains a description for a column.static interface
Groupings of columns that work together in certain Amazon QuickSight features.static interface
A rule defined to grant access on one or more restricted columns.static interface
A tag for a column in a[TagColumnOperation](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_TagColumnOperation.html)
structure.static interface
A transform operation that creates calculated columns.static interface
A physical table type built from the results of the custom SQL query.static interface
The parameter declarations of the dataset.static interface
The refresh properties of a dataset.static interface
The usage configuration to apply to child datasets that reference this dataset as a source.static interface
The default values of a date time parameter.static interface
A date time parameter that is created in the dataset.static interface
A list of default values for a given decimal parameter.static interface
A decimal parameter that is created in the dataset.static interface
A FieldFolder element is a folder that contains fields and nested subfolders.static interface
A transform operation that filters rows based on a condition.static interface
Geospatial column group that denotes a hierarchy.static interface
The incremental refresh configuration for a dataset.static interface
The wait policy to use when creating or updating a Dataset.static interface
Metadata for a column that is used as the input of a transform operation.static interface
A list of default values for a given integer parameter.static interface
An integer parameter that is created in the dataset.static interface
The instructions associated with a join.static interface
Properties associated with the columns participating in a join.static interface
A logical table is a unit that joins and that data transformations operate on.static interface
Information about the source of a logical table.static interface
The lookback window setup of an incremental refresh configuration.static interface
The new default values for the parameter.static interface
Output column.static interface
A transform operation that overrides the dataset parameter values that are defined in another dataset.static interface
A view of a data source that contains information about the shape of the data in the underlying source.static interface
A transform operation that projects columns.static interface
The refresh configuration of a dataset.static interface
A physical table type for relational data sources.static interface
A transform operation that renames a column.static interface
Permission for the resource.static interface
Information about a dataset that contains permissions for row-level security (RLS).static interface
The element you can use to define tags for row-level security.static interface
A set of rules associated with a tag.static interface
A physical table type for an S3 data source.static interface
A list of default values for a given string dataset parameter type.static interface
A string parameter that is created in the dataset.static interface
A transform operation that tags a column with additional information.static interface
A data transformation on a logical table.static interface
A transform operation that removes tags associated with a column.static interface
Information about the format for a source file or files.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnDataSet
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnDataSet
(software.amazon.jsii.JsiiObjectRef objRef) CfnDataSet
(software.constructs.Construct scope, String id) CfnDataSet
(software.constructs.Construct scope, String id, CfnDataSetProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name (ARN) of the dataset.The amount of SPICE capacity used by this dataset.The time this dataset version was created.The time this dataset version was last updated.The list of columns after all transforms.The AWS account ID.Groupings of columns that work together in certain Amazon QuickSight features.A set of one or more definitions of aColumnLevelPermissionRule
.An ID for the dataset that you want to create.The parameters that are declared in a dataset.The refresh properties of a dataset.The usage configuration to apply to child datasets that reference this dataset as a source.The folder that contains fields and nested subfolders for your dataset.When you create the dataset, Amazon QuickSight adds the dataset to these folders.Indicates whether you want to import the data into SPICE.The wait policy to use when creating or updating a Dataset.Configures the combination and transformation of the data from the physical tables.getName()
The display name for the dataset.A list of resource permissions on the dataset.Declares the physical tables that are available in the underlying data sources.The row-level security configuration for the data that you want to create.The element you can use to define tags for row-level security.getTags()
Tag Manager which manages the tags for this resource.Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setAwsAccountId
(String value) The AWS account ID.void
setColumnGroups
(List<Object> value) Groupings of columns that work together in certain Amazon QuickSight features.void
setColumnGroups
(IResolvable value) Groupings of columns that work together in certain Amazon QuickSight features.void
setColumnLevelPermissionRules
(List<Object> value) A set of one or more definitions of aColumnLevelPermissionRule
.void
A set of one or more definitions of aColumnLevelPermissionRule
.void
setDataSetId
(String value) An ID for the dataset that you want to create.void
setDatasetParameters
(List<Object> value) The parameters that are declared in a dataset.void
setDatasetParameters
(IResolvable value) The parameters that are declared in a dataset.void
The refresh properties of a dataset.void
The refresh properties of a dataset.void
The usage configuration to apply to child datasets that reference this dataset as a source.void
The usage configuration to apply to child datasets that reference this dataset as a source.void
setFieldFolders
(Map<String, Object> value) The folder that contains fields and nested subfolders for your dataset.void
setFieldFolders
(IResolvable value) The folder that contains fields and nested subfolders for your dataset.void
setFolderArns
(List<String> value) When you create the dataset, Amazon QuickSight adds the dataset to these folders.void
setImportMode
(String value) Indicates whether you want to import the data into SPICE.void
The wait policy to use when creating or updating a Dataset.void
The wait policy to use when creating or updating a Dataset.void
setLogicalTableMap
(Map<String, Object> value) Configures the combination and transformation of the data from the physical tables.void
setLogicalTableMap
(IResolvable value) Configures the combination and transformation of the data from the physical tables.void
The display name for the dataset.void
setPermissions
(List<Object> value) A list of resource permissions on the dataset.void
setPermissions
(IResolvable value) A list of resource permissions on the dataset.void
setPhysicalTableMap
(Map<String, Object> value) Declares the physical tables that are available in the underlying data sources.void
setPhysicalTableMap
(IResolvable value) Declares the physical tables that are available in the underlying data sources.void
The row-level security configuration for the data that you want to create.void
The row-level security configuration for the data that you want to create.void
The element you can use to define tags for row-level security.void
The element you can use to define tags for row-level security.void
setTagsRaw
(List<CfnTag> value) Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
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
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- 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 classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrArn
The Amazon Resource Name (ARN) of the dataset. -
getAttrConsumedSpiceCapacityInBytes
The amount of SPICE capacity used by this dataset.
This is 0 if the dataset isn't imported into SPICE.
-
getAttrCreatedTime
The time this dataset version was created. -
getAttrLastUpdatedTime
The time this dataset version was last updated. -
getAttrOutputColumns
The list of columns after all transforms.
These columns are available in templates, analyses, and dashboards.
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getAwsAccountId
The AWS account ID. -
setAwsAccountId
The AWS account ID. -
getColumnGroups
Groupings of columns that work together in certain Amazon QuickSight features. -
setColumnGroups
Groupings of columns that work together in certain Amazon QuickSight features. -
setColumnGroups
Groupings of columns that work together in certain Amazon QuickSight features. -
getColumnLevelPermissionRules
A set of one or more definitions of aColumnLevelPermissionRule
. -
setColumnLevelPermissionRules
A set of one or more definitions of aColumnLevelPermissionRule
. -
setColumnLevelPermissionRules
A set of one or more definitions of aColumnLevelPermissionRule
. -
getDataSetId
An ID for the dataset that you want to create. -
setDataSetId
An ID for the dataset that you want to create. -
getDatasetParameters
The parameters that are declared in a dataset. -
setDatasetParameters
The parameters that are declared in a dataset. -
setDatasetParameters
The parameters that are declared in a dataset. -
getDataSetRefreshProperties
The refresh properties of a dataset. -
setDataSetRefreshProperties
The refresh properties of a dataset. -
setDataSetRefreshProperties
@Stability(Stable) public void setDataSetRefreshProperties(@Nullable CfnDataSet.DataSetRefreshPropertiesProperty value) The refresh properties of a dataset. -
getDataSetUsageConfiguration
The usage configuration to apply to child datasets that reference this dataset as a source. -
setDataSetUsageConfiguration
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
The folder that contains fields and nested subfolders for your dataset. -
setFieldFolders
The folder that contains fields and nested subfolders for your dataset. -
setFieldFolders
The folder that contains fields and nested subfolders for your dataset. -
getFolderArns
When you create the dataset, Amazon QuickSight adds the dataset to these folders.
. -
setFolderArns
When you create the dataset, Amazon QuickSight adds the dataset to these folders.
. -
getImportMode
Indicates whether you want to import the data into SPICE. -
setImportMode
Indicates whether you want to import the data into SPICE. -
getIngestionWaitPolicy
The wait policy to use when creating or updating a Dataset. -
setIngestionWaitPolicy
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
Configures the combination and transformation of the data from the physical tables. -
setLogicalTableMap
Configures the combination and transformation of the data from the physical tables. -
setLogicalTableMap
Configures the combination and transformation of the data from the physical tables. -
getName
The display name for the dataset. -
setName
The display name for the dataset. -
getPermissions
A list of resource permissions on the dataset. -
setPermissions
A list of resource permissions on the dataset. -
setPermissions
A list of resource permissions on the dataset. -
getPhysicalTableMap
Declares the physical tables that are available in the underlying data sources. -
setPhysicalTableMap
Declares the physical tables that are available in the underlying data sources. -
setPhysicalTableMap
Declares the physical tables that are available in the underlying data sources. -
getRowLevelPermissionDataSet
The row-level security configuration for the data that you want to create. -
setRowLevelPermissionDataSet
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
The element you can use to define tags for row-level security. -
setRowLevelPermissionTagConfiguration
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
Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset. -
setTagsRaw
Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.
-