Class CfnDataSet
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.quicksight.CfnDataSet
- All Implemented Interfaces:
IConstruct
,IDependable
,IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
date="2023-06-19T16:30:23.284Z")
@Stability(Stable)
public class CfnDataSet
extends CfnResource
implements IInspectable
A CloudFormation
AWS::QuickSight::DataSet
.
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") .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()) .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") .build())) .dataSourceArn("dataSourceArn") .name("name") .sqlQuery("sqlQuery") .build()) .relationalTable(RelationalTableProperty.builder() .dataSourceArn("dataSourceArn") .inputColumns(List.of(InputColumnProperty.builder() .name("name") .type("type") .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") .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();
-
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
Example:static interface
Example:static interface
The usage configuration to apply to child datasets that reference this dataset as a source.static interface
Example:static interface
Example:static interface
Example:static interface
Example: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
Example: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
Example:static interface
Example: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
Example:static interface
Example:static interface
Output column.static interface
Example: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
Example: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
Example:static interface
Example:static interface
A physical table type for an S3 data source.static interface
Example:static interface
Example:static interface
A transform operation that tags a column with additional information.static interface
A data transformation on a logical table.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.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionCfnDataSet
(Construct scope, String id) Create a newAWS::QuickSight::DataSet
.CfnDataSet
(Construct scope, String id, CfnDataSetProps props) Create a newAWS::QuickSight::DataSet
.protected
CfnDataSet
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnDataSet
(software.amazon.jsii.JsiiObjectRef objRef) -
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name (ARN) of the dataset.The time this dataset version was created.The time this dataset version was last updated.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.AWS::QuickSight::DataSet.DatasetParameters
.AWS::QuickSight::DataSet.DataSetRefreshProperties
.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.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()
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) AWS::QuickSight::DataSet.DatasetParameters
.void
setDatasetParameters
(IResolvable value) AWS::QuickSight::DataSet.DatasetParameters
.void
AWS::QuickSight::DataSet.DataSetRefreshProperties
.void
AWS::QuickSight::DataSet.DataSetRefreshProperties
.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
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.Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
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 Construct scope, @NotNull String id, @Nullable CfnDataSetProps props) Create a newAWS::QuickSight::DataSet
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
props
-- resource properties.
-
CfnDataSet
Create a newAWS::QuickSight::DataSet
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
-- tree inspector to collect and process attributes.
-
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
-
getAttrCreatedTime
The time this dataset version was created. -
getAttrLastUpdatedTime
The time this dataset version was last updated. -
getAttrOutputColumns
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset. -
getAwsAccountId
The AWS account ID. -
setAwsAccountId
The AWS account ID. -
getColumnGroups
Groupings of columns that work together in certain Amazon QuickSight features.Currently, only geospatial hierarchy is supported.
-
setColumnGroups
Groupings of columns that work together in certain Amazon QuickSight features.Currently, only geospatial hierarchy is supported.
-
setColumnGroups
Groupings of columns that work together in certain Amazon QuickSight features.Currently, only geospatial hierarchy is supported.
-
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.This ID is unique per AWS Region for each AWS account.
-
setDataSetId
An ID for the dataset that you want to create.This ID is unique per AWS Region for each AWS account.
-
getDatasetParameters
AWS::QuickSight::DataSet.DatasetParameters
. -
setDatasetParameters
AWS::QuickSight::DataSet.DatasetParameters
. -
setDatasetParameters
AWS::QuickSight::DataSet.DatasetParameters
. -
getDataSetRefreshProperties
AWS::QuickSight::DataSet.DataSetRefreshProperties
. -
setDataSetRefreshProperties
AWS::QuickSight::DataSet.DataSetRefreshProperties
. -
setDataSetRefreshProperties
@Stability(Stable) public void setDataSetRefreshProperties(@Nullable CfnDataSet.DataSetRefreshPropertiesProperty value) AWS::QuickSight::DataSet.DataSetRefreshProperties
. -
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. -
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.The default is to wait for SPICE ingestion to finish with timeout of 36 hours.
-
setIngestionWaitPolicy
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.
-
setIngestionWaitPolicy
@Stability(Stable) public void setIngestionWaitPolicy(@Nullable CfnDataSet.IngestionWaitPolicyProperty value) 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.
-
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.
-