Class CfnDataSet

Creates a dataset.

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnDataSet
Implements
IConstruct
IDependable
Inherited Members
Namespace: Amazon.CDK.AWS.QuickSight
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDataSet : CfnResource, IInspectable, IDataSetRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Syntax (vb)
Public Class CfnDataSet Inherits CfnResource Implements IInspectable, IDataSetRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html

CloudformationResource: AWS::QuickSight::DataSet

ExampleMetadata: fixture=_generated

Synopsis

Constructors

CfnDataSet(Construct, string, ICfnDataSetProps?)

Create a new AWS::QuickSight::DataSet.

Properties

AttrArn

The Amazon Resource Name (ARN) of the dataset.
AttrConsumedSpiceCapacityInBytes

<p>The amount of SPICE capacity used by this dataset.
AttrCreatedTime

The time this dataset version was created.
AttrLastUpdatedTime

The time this dataset version was last updated.
AttrOutputColumns

<p>The list of columns after all transforms.
AwsAccountId

The AWS account ID.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties

Creates a dataset.
ColumnGroups

Groupings of columns that work together in certain Amazon Quick Sight features.
ColumnLevelPermissionRules

A set of one or more definitions of a ColumnLevelPermissionRule .
DataPrepConfiguration

The data preparation configuration associated with this dataset.
DataSetId

An ID for the dataset that you want to create.
DataSetRef

A reference to a DataSet resource.
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, Quick Suite 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

Creates a dataset.
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

Tag Manager which manages the tags for this resource.
TagsRaw

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

The usage of the dataset.

Methods

ArnForDataSet(IDataSetRef)

Creates a dataset.
Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
IsCfnDataSet(object)

Checks whether the given object is a CfnDataSet.
RenderProperties(IDictionary<string, object>)

Creates a dataset.

Constructors

CfnDataSet(Construct, string, ICfnDataSetProps?)

Create a new AWS::QuickSight::DataSet.

public CfnDataSet(Construct scope, string id, ICfnDataSetProps? props = null)
Parameters
scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnDataSetProps

Resource properties.

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html

CloudformationResource: AWS::QuickSight::DataSet

ExampleMetadata: fixture=_generated

Properties

AttrArn

The Amazon Resource Name (ARN) of the dataset.

public virtual string AttrArn { get; }
Property Value

string

Remarks

CloudformationAttribute: Arn

AttrConsumedSpiceCapacityInBytes

<p>The amount of SPICE capacity used by this dataset.

public virtual IResolvable AttrConsumedSpiceCapacityInBytes { get; }
Property Value

IResolvable

Remarks

This is 0 if the dataset isn't imported into SPICE.</p>

CloudformationAttribute: ConsumedSpiceCapacityInBytes

AttrCreatedTime

The time this dataset version was created.

public virtual string AttrCreatedTime { get; }
Property Value

string

Remarks

CloudformationAttribute: CreatedTime

AttrLastUpdatedTime

The time this dataset version was last updated.

public virtual string AttrLastUpdatedTime { get; }
Property Value

string

Remarks

CloudformationAttribute: LastUpdatedTime

AttrOutputColumns

<p>The list of columns after all transforms.

public virtual IResolvable AttrOutputColumns { get; }
Property Value

IResolvable

Remarks

These columns are available in templates, analyses, and dashboards.</p>

CloudformationAttribute: OutputColumns

AwsAccountId

The AWS account ID.

public virtual string? AwsAccountId { get; set; }
Property Value

string

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html

CloudformationResource: AWS::QuickSight::DataSet

ExampleMetadata: fixture=_generated

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

string

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html

CloudformationResource: AWS::QuickSight::DataSet

ExampleMetadata: fixture=_generated

CfnProperties

Creates a dataset.

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

IDictionary<string, object>

Overrides
Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html

CloudformationResource: AWS::QuickSight::DataSet

ExampleMetadata: fixture=_generated

ColumnGroups

Groupings of columns that work together in certain Amazon Quick Sight features.

public virtual object? ColumnGroups { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnDataSet.IColumnGroupProperty)[]

ColumnLevelPermissionRules

A set of one or more definitions of a ColumnLevelPermissionRule .

public virtual object? ColumnLevelPermissionRules { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnDataSet.IColumnLevelPermissionRuleProperty)[]

DataPrepConfiguration

The data preparation configuration associated with this dataset.

public virtual object? DataPrepConfiguration { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnDataSet.IDataPrepConfigurationProperty

DataSetId

An ID for the dataset that you want to create.

public virtual string? DataSetId { get; set; }
Property Value

string

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html

CloudformationResource: AWS::QuickSight::DataSet

ExampleMetadata: fixture=_generated

DataSetRef

A reference to a DataSet resource.

public virtual IDataSetReference DataSetRef { get; }
Property Value

IDataSetReference

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html

CloudformationResource: AWS::QuickSight::DataSet

ExampleMetadata: fixture=_generated

DataSetRefreshProperties

The refresh properties of a dataset.

public virtual object? DataSetRefreshProperties { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnDataSet.IDataSetRefreshPropertiesProperty

DataSetUsageConfiguration

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

public virtual object? DataSetUsageConfiguration { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnDataSet.IDataSetUsageConfigurationProperty

DatasetParameters

The parameters that are declared in a dataset.

public virtual object? DatasetParameters { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnDataSet.IDatasetParameterProperty)[]

FieldFolders

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

public virtual object? FieldFolders { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or Dictionary<string, either IResolvable or CfnDataSet.IFieldFolderProperty>

FolderArns

<p>When you create the dataset, Quick Suite adds the dataset to these folders.</p>.

public virtual string[]? FolderArns { get; set; }
Property Value

string[]

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html

CloudformationResource: AWS::QuickSight::DataSet

ExampleMetadata: fixture=_generated

ImportMode

Indicates whether you want to import the data into SPICE.

public virtual string? ImportMode { get; set; }
Property Value

string

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html

CloudformationResource: AWS::QuickSight::DataSet

ExampleMetadata: fixture=_generated

IngestionWaitPolicy

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

public virtual object? IngestionWaitPolicy { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnDataSet.IIngestionWaitPolicyProperty

LogicalTableMap

Creates a dataset.

[Obsolete("this property has been deprecated")]
public virtual object? LogicalTableMap { get; set; }
Property Value

object

Remarks

Stability: Deprecated

Type union: either IResolvable or Dictionary<string, either IResolvable or CfnDataSet.ILogicalTableProperty>

Name

The display name for the dataset.

public virtual string? Name { get; set; }
Property Value

string

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html

CloudformationResource: AWS::QuickSight::DataSet

ExampleMetadata: fixture=_generated

PerformanceConfiguration

The performance optimization configuration of a dataset.

public virtual object? PerformanceConfiguration { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnDataSet.IPerformanceConfigurationProperty

Permissions

A list of resource permissions on the dataset.

public virtual object? Permissions { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnDataSet.IResourcePermissionProperty)[]

PhysicalTableMap

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

public virtual object? PhysicalTableMap { get; set; }
Property Value

object

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 virtual object? RowLevelPermissionDataSet { get; set; }
Property Value

object

Remarks

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 virtual object? RowLevelPermissionTagConfiguration { get; set; }
Property Value

object

Remarks

Stability: Deprecated

Type union: either IResolvable or CfnDataSet.IRowLevelPermissionTagConfigurationProperty

SemanticModelConfiguration

The semantic model configuration associated with this dataset.

public virtual object? SemanticModelConfiguration { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnDataSet.ISemanticModelConfigurationProperty

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }
Property Value

TagManager

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html

CloudformationResource: AWS::QuickSight::DataSet

ExampleMetadata: fixture=_generated

TagsRaw

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

public virtual ICfnTag[]? TagsRaw { get; set; }
Property Value

ICfnTag[]

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html

CloudformationResource: AWS::QuickSight::DataSet

ExampleMetadata: fixture=_generated

UseAs

The usage of the dataset.

public virtual string? UseAs { get; set; }
Property Value

string

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html

CloudformationResource: AWS::QuickSight::DataSet

ExampleMetadata: fixture=_generated

Methods

ArnForDataSet(IDataSetRef)

Creates a dataset.

public static string ArnForDataSet(IDataSetRef resource)
Parameters
resource IDataSetRef
Returns

string

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html

CloudformationResource: AWS::QuickSight::DataSet

ExampleMetadata: fixture=_generated

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html

CloudformationResource: AWS::QuickSight::DataSet

ExampleMetadata: fixture=_generated

IsCfnDataSet(object)

Checks whether the given object is a CfnDataSet.

public static bool IsCfnDataSet(object x)
Parameters
x object
Returns

bool

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html

CloudformationResource: AWS::QuickSight::DataSet

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Creates a dataset.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props IDictionary<string, object>
Returns

IDictionary<string, object>

Overrides
Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html

CloudformationResource: AWS::QuickSight::DataSet

ExampleMetadata: fixture=_generated

Implements

Constructs.IConstruct
Constructs.IDependable