Class CfnDataSetProps
Properties for defining a CfnDataSet.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.QuickSight
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDataSetProps : ICfnDataSetPropsSyntax (vb)
Public Class CfnDataSetProps Implements ICfnDataSetPropsRemarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html
ExampleMetadata: fixture=_generated
Synopsis
Constructors
| CfnDataSetProps() | Properties for defining a |
Properties
| AwsAccountId | The AWS account ID. |
| ColumnGroups | Groupings of columns that work together in certain Amazon Quick Sight features. |
| ColumnLevelPermissionRules | A set of one or more definitions of a |
| DataPrepConfiguration | The data preparation configuration associated with this dataset. |
| DataSetId | An ID for the dataset that you want to create. |
| DataSetRefreshProperties | The refresh properties of a dataset. |
| DataSetUsageConfiguration | The usage configuration to apply to child datasets that reference this dataset as a source. |
| DatasetParameters | The parameters that are declared in a dataset. |
| FieldFolders | The folder that contains fields and nested subfolders for your dataset. |
| FolderArns | <p>When you create the dataset, Amazon QuickSight adds the dataset to these folders.</p>. |
| ImportMode | Indicates whether you want to import the data into SPICE. |
| IngestionWaitPolicy | The wait policy to use when creating or updating a Dataset. |
| LogicalTableMap | Properties for defining a |
| Name | The display name for the dataset. |
| PerformanceConfiguration | The performance optimization configuration of a dataset. |
| Permissions | A list of resource permissions on the dataset. |
| PhysicalTableMap | Declares the physical tables that are available in the underlying data sources. |
| RowLevelPermissionDataSet | (deprecated) <p>Information about a dataset that contains permissions for row-level security (RLS). |
| RowLevelPermissionTagConfiguration | (deprecated) <p>The configuration of tags on a dataset to set row-level security. |
| SemanticModelConfiguration | The semantic model configuration associated with this dataset. |
| Tags | Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset. |
| UseAs | The usage of the dataset. |
Constructors
CfnDataSetProps()
Properties for defining a CfnDataSet.
public CfnDataSetProps()Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html
ExampleMetadata: fixture=_generated
Properties
AwsAccountId
The AWS account ID.
public string? AwsAccountId { get; set; }Property Value
Remarks
ColumnGroups
Groupings of columns that work together in certain Amazon Quick Sight features.
public object? ColumnGroups { get; set; }Property Value
Remarks
Currently, only geospatial hierarchy is supported.
Type union: either IResolvable or (either IResolvable or CfnDataSet.IColumnGroupProperty)[]
ColumnLevelPermissionRules
A set of one or more definitions of a ColumnLevelPermissionRule .
public object? ColumnLevelPermissionRules { get; set; }Property Value
Remarks
DataPrepConfiguration
The data preparation configuration associated with this dataset.
public object? DataPrepConfiguration { get; set; }Property Value
Remarks
DataSetId
An ID for the dataset that you want to create.
public string? DataSetId { get; set; }Property Value
Remarks
This ID is unique per AWS Region for each AWS account.
DataSetRefreshProperties
The refresh properties of a dataset.
public object? DataSetRefreshProperties { get; set; }Property Value
Remarks
DataSetUsageConfiguration
The usage configuration to apply to child datasets that reference this dataset as a source.
public object? DataSetUsageConfiguration { get; set; }Property Value
Remarks
DatasetParameters
The parameters that are declared in a dataset.
public object? DatasetParameters { get; set; }Property Value
Remarks
FieldFolders
The folder that contains fields and nested subfolders for your dataset.
public object? FieldFolders { get; set; }Property Value
Remarks
Type union: either IResolvable or Dictionary<string, either IResolvable or CfnDataSet.IFieldFolderProperty>
FolderArns
<p>When you create the dataset, Amazon QuickSight adds the dataset to these folders.</p>.
public string[]? FolderArns { get; set; }Property Value
string[]
Remarks
ImportMode
Indicates whether you want to import the data into SPICE.
public string? ImportMode { get; set; }Property Value
Remarks
IngestionWaitPolicy
The wait policy to use when creating or updating a Dataset.
public object? IngestionWaitPolicy { get; set; }Property Value
Remarks
The default is to wait for SPICE ingestion to finish with timeout of 36 hours.
Type union: either IResolvable or CfnDataSet.IIngestionWaitPolicyProperty
LogicalTableMap
Properties for defining a CfnDataSet.
[Obsolete("this property has been deprecated")]
public object? LogicalTableMap { get; set; }Property Value
Remarks
Stability: Deprecated
Type union: either IResolvable or Dictionary<string, either IResolvable or CfnDataSet.ILogicalTableProperty>
Name
The display name for the dataset.
public string? Name { get; set; }Property Value
Remarks
PerformanceConfiguration
The performance optimization configuration of a dataset.
public object? PerformanceConfiguration { get; set; }Property Value
Remarks
Permissions
A list of resource permissions on the dataset.
public object? Permissions { get; set; }Property Value
Remarks
PhysicalTableMap
Declares the physical tables that are available in the underlying data sources.
public object? PhysicalTableMap { get; set; }Property Value
Remarks
Type union: either IResolvable or Dictionary<string, either IResolvable or CfnDataSet.IPhysicalTableProperty>
RowLevelPermissionDataSet
(deprecated) <p>Information about a dataset that contains permissions for row-level security (RLS).
[Obsolete("this property has been deprecated")]
public object? RowLevelPermissionDataSet { get; set; }Property Value
Remarks
The permissions dataset maps fields to users or groups. For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/restrict-access-to-a-data-set-using-row-level-security.html">Using Row-Level Security (RLS) to Restrict Access to a Dataset</a> in the <i>Amazon QuickSight User Guide</i>.</p>
The option to deny permissions by setting PermissionPolicy to DENY_ACCESS is
not supported for new RLS datasets.
Stability: Deprecated
Type union: either IResolvable or CfnDataSet.IRowLevelPermissionDataSetProperty
RowLevelPermissionTagConfiguration
(deprecated) <p>The configuration of tags on a dataset to set row-level security.
[Obsolete("this property has been deprecated")]
public object? RowLevelPermissionTagConfiguration { get; set; }Property Value
Remarks
</p>
Stability: Deprecated
Type union: either IResolvable or CfnDataSet.IRowLevelPermissionTagConfigurationProperty
SemanticModelConfiguration
The semantic model configuration associated with this dataset.
public object? SemanticModelConfiguration { get; set; }Property Value
Remarks
Tags
Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.
public ICfnTag[]? Tags { get; set; }Property Value
ICfnTag[]
Remarks
UseAs
The usage of the dataset.
public string? UseAs { get; set; }