Class CfnDataSet
Creates a dataset.
Inherited Members
Namespace: Amazon.CDK.AWS.QuickSight
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDataSet : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnDataSet
Inherits CfnResource
Implements IInspectable, 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
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.QuickSight;
var tagRuleConfigurations;
var cfnDataSet = new CfnDataSet(this, "MyCfnDataSet", new CfnDataSetProps {
AwsAccountId = "awsAccountId",
ColumnGroups = new [] { new ColumnGroupProperty {
GeoSpatialColumnGroup = new GeoSpatialColumnGroupProperty {
Columns = new [] { "columns" },
Name = "name",
// the properties below are optional
CountryCode = "countryCode"
}
} },
ColumnLevelPermissionRules = new [] { new ColumnLevelPermissionRuleProperty {
ColumnNames = new [] { "columnNames" },
Principals = new [] { "principals" }
} },
DataSetId = "dataSetId",
DatasetParameters = new [] { new DatasetParameterProperty {
DateTimeDatasetParameter = new DateTimeDatasetParameterProperty {
Id = "id",
Name = "name",
ValueType = "valueType",
// the properties below are optional
DefaultValues = new DateTimeDatasetParameterDefaultValuesProperty {
StaticValues = new [] { "staticValues" }
},
TimeGranularity = "timeGranularity"
},
DecimalDatasetParameter = new DecimalDatasetParameterProperty {
Id = "id",
Name = "name",
ValueType = "valueType",
// the properties below are optional
DefaultValues = new DecimalDatasetParameterDefaultValuesProperty {
StaticValues = new [] { 123 }
}
},
IntegerDatasetParameter = new IntegerDatasetParameterProperty {
Id = "id",
Name = "name",
ValueType = "valueType",
// the properties below are optional
DefaultValues = new IntegerDatasetParameterDefaultValuesProperty {
StaticValues = new [] { 123 }
}
},
StringDatasetParameter = new StringDatasetParameterProperty {
Id = "id",
Name = "name",
ValueType = "valueType",
// the properties below are optional
DefaultValues = new StringDatasetParameterDefaultValuesProperty {
StaticValues = new [] { "staticValues" }
}
}
} },
DataSetRefreshProperties = new DataSetRefreshPropertiesProperty {
RefreshConfiguration = new RefreshConfigurationProperty {
IncrementalRefresh = new IncrementalRefreshProperty {
LookbackWindow = new LookbackWindowProperty {
ColumnName = "columnName",
Size = 123,
SizeUnit = "sizeUnit"
}
}
}
},
DataSetUsageConfiguration = new DataSetUsageConfigurationProperty {
DisableUseAsDirectQuerySource = false,
DisableUseAsImportedSource = false
},
FieldFolders = new Dictionary<string, object> {
{ "fieldFoldersKey", new FieldFolderProperty {
Columns = new [] { "columns" },
Description = "description"
} }
},
ImportMode = "importMode",
IngestionWaitPolicy = new IngestionWaitPolicyProperty {
IngestionWaitTimeInHours = 123,
WaitForSpiceIngestion = false
},
LogicalTableMap = new Dictionary<string, object> {
{ "logicalTableMapKey", new LogicalTableProperty {
Alias = "alias",
Source = new LogicalTableSourceProperty {
DataSetArn = "dataSetArn",
JoinInstruction = new JoinInstructionProperty {
LeftOperand = "leftOperand",
OnClause = "onClause",
RightOperand = "rightOperand",
Type = "type",
// the properties below are optional
LeftJoinKeyProperties = new JoinKeyPropertiesProperty {
UniqueKey = false
},
RightJoinKeyProperties = new JoinKeyPropertiesProperty {
UniqueKey = false
}
},
PhysicalTableId = "physicalTableId"
},
// the properties below are optional
DataTransforms = new [] { new TransformOperationProperty {
CastColumnTypeOperation = new CastColumnTypeOperationProperty {
ColumnName = "columnName",
NewColumnType = "newColumnType",
// the properties below are optional
Format = "format",
SubType = "subType"
},
CreateColumnsOperation = new CreateColumnsOperationProperty {
Columns = new [] { new CalculatedColumnProperty {
ColumnId = "columnId",
ColumnName = "columnName",
Expression = "expression"
} }
},
FilterOperation = new FilterOperationProperty {
ConditionExpression = "conditionExpression"
},
OverrideDatasetParameterOperation = new OverrideDatasetParameterOperationProperty {
ParameterName = "parameterName",
// the properties below are optional
NewDefaultValues = new NewDefaultValuesProperty {
DateTimeStaticValues = new [] { "dateTimeStaticValues" },
DecimalStaticValues = new [] { 123 },
IntegerStaticValues = new [] { 123 },
StringStaticValues = new [] { "stringStaticValues" }
},
NewParameterName = "newParameterName"
},
ProjectOperation = new ProjectOperationProperty {
ProjectedColumns = new [] { "projectedColumns" }
},
RenameColumnOperation = new RenameColumnOperationProperty {
ColumnName = "columnName",
NewColumnName = "newColumnName"
},
TagColumnOperation = new TagColumnOperationProperty {
ColumnName = "columnName",
Tags = new [] { new ColumnTagProperty {
ColumnDescription = new ColumnDescriptionProperty {
Text = "text"
},
ColumnGeographicRole = "columnGeographicRole"
} }
}
} }
} }
},
Name = "name",
Permissions = new [] { new ResourcePermissionProperty {
Actions = new [] { "actions" },
Principal = "principal"
} },
PhysicalTableMap = new Dictionary<string, object> {
{ "physicalTableMapKey", new PhysicalTableProperty {
CustomSql = new CustomSqlProperty {
Columns = new [] { new InputColumnProperty {
Name = "name",
Type = "type",
// the properties below are optional
SubType = "subType"
} },
DataSourceArn = "dataSourceArn",
Name = "name",
SqlQuery = "sqlQuery"
},
RelationalTable = new RelationalTableProperty {
DataSourceArn = "dataSourceArn",
InputColumns = new [] { new InputColumnProperty {
Name = "name",
Type = "type",
// the properties below are optional
SubType = "subType"
} },
Name = "name",
// the properties below are optional
Catalog = "catalog",
Schema = "schema"
},
S3Source = new S3SourceProperty {
DataSourceArn = "dataSourceArn",
InputColumns = new [] { new InputColumnProperty {
Name = "name",
Type = "type",
// the properties below are optional
SubType = "subType"
} },
// the properties below are optional
UploadSettings = new UploadSettingsProperty {
ContainsHeader = false,
Delimiter = "delimiter",
Format = "format",
StartFromRow = 123,
TextQualifier = "textQualifier"
}
}
} }
},
RowLevelPermissionDataSet = new RowLevelPermissionDataSetProperty {
Arn = "arn",
PermissionPolicy = "permissionPolicy",
// the properties below are optional
FormatVersion = "formatVersion",
Namespace = "namespace",
Status = "status"
},
RowLevelPermissionTagConfiguration = new RowLevelPermissionTagConfigurationProperty {
TagRules = new [] { new RowLevelPermissionTagRuleProperty {
ColumnName = "columnName",
TagKey = "tagKey",
// the properties below are optional
MatchAllValue = "matchAllValue",
TagMultiValueDelimiter = "tagMultiValueDelimiter"
} },
// the properties below are optional
Status = "status",
TagRuleConfigurations = tagRuleConfigurations
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnDataSet(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnDataSet(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnDataSet(Construct, String, ICfnDataSetProps) |
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 | |
ColumnGroups | Groupings of columns that work together in certain Amazon QuickSight features. |
ColumnLevelPermissionRules | A set of one or more definitions of a |
DataSetId | An ID for the dataset that you want to create. |
DatasetParameters | The parameters that are declared in a dataset. |
DataSetRefreshProperties | The refresh properties of a dataset. |
DataSetUsageConfiguration | The usage configuration to apply to child datasets that reference this dataset as a source. |
FieldFolders | The folder that contains fields and nested subfolders for your dataset. |
ImportMode | Indicates whether you want to import the data into SPICE. |
IngestionWaitPolicy | The wait policy to use when creating or updating a Dataset. |
LogicalTableMap | Configures the combination and transformation of the data from the physical tables. |
Name | The display name for the dataset. |
Permissions | A list of resource permissions on the dataset. |
PhysicalTableMap | Declares the physical tables that are available in the underlying data sources. |
RowLevelPermissionDataSet | The row-level security configuration for the data that you want to create. |
RowLevelPermissionTagConfiguration | The element you can use to define tags for row-level security. |
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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDataSet(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDataSet(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnDataSet(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDataSet(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnDataSet(Construct, String, ICfnDataSetProps)
public CfnDataSet(Construct scope, string id, ICfnDataSetProps props = null)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnDataSetProps
Resource properties.
Properties
AttrArn
The Amazon Resource Name (ARN) of the dataset.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrConsumedSpiceCapacityInBytes
<p>The amount of SPICE capacity used by this dataset.
public virtual IResolvable AttrConsumedSpiceCapacityInBytes { get; }
Property Value
Remarks
This is 0 if the dataset isn't imported into SPICE.
CloudformationAttribute: ConsumedSpiceCapacityInBytes
AttrCreatedTime
The time this dataset version was created.
public virtual string AttrCreatedTime { get; }
Property Value
System.String
Remarks
CloudformationAttribute: CreatedTime
AttrLastUpdatedTime
The time this dataset version was last updated.
public virtual string AttrLastUpdatedTime { get; }
Property Value
System.String
Remarks
CloudformationAttribute: LastUpdatedTime
AttrOutputColumns
<p>The list of columns after all transforms.
public virtual IResolvable AttrOutputColumns { get; }
Property Value
Remarks
These columns are available in templates, analyses, and dashboards.
CloudformationAttribute: OutputColumns
AwsAccountId
The AWS account ID.
public virtual string AwsAccountId { get; set; }
Property Value
System.String
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ColumnGroups
Groupings of columns that work together in certain Amazon QuickSight features.
public virtual object ColumnGroups { get; set; }
Property Value
System.Object
ColumnLevelPermissionRules
A set of one or more definitions of a ColumnLevelPermissionRule
.
public virtual object ColumnLevelPermissionRules { get; set; }
Property Value
System.Object
DataSetId
An ID for the dataset that you want to create.
public virtual string DataSetId { get; set; }
Property Value
System.String
DatasetParameters
The parameters that are declared in a dataset.
public virtual object DatasetParameters { get; set; }
Property Value
System.Object
DataSetRefreshProperties
The refresh properties of a dataset.
public virtual object DataSetRefreshProperties { get; set; }
Property Value
System.Object
DataSetUsageConfiguration
The usage configuration to apply to child datasets that reference this dataset as a source.
public virtual object DataSetUsageConfiguration { get; set; }
Property Value
System.Object
FieldFolders
The folder that contains fields and nested subfolders for your dataset.
public virtual object FieldFolders { get; set; }
Property Value
System.Object
ImportMode
Indicates whether you want to import the data into SPICE.
public virtual string ImportMode { get; set; }
Property Value
System.String
IngestionWaitPolicy
The wait policy to use when creating or updating a Dataset.
public virtual object IngestionWaitPolicy { get; set; }
Property Value
System.Object
LogicalTableMap
Configures the combination and transformation of the data from the physical tables.
public virtual object LogicalTableMap { get; set; }
Property Value
System.Object
Name
The display name for the dataset.
public virtual string Name { get; set; }
Property Value
System.String
Permissions
A list of resource permissions on the dataset.
public virtual object Permissions { get; set; }
Property Value
System.Object
PhysicalTableMap
Declares the physical tables that are available in the underlying data sources.
public virtual object PhysicalTableMap { get; set; }
Property Value
System.Object
RowLevelPermissionDataSet
The row-level security configuration for the data that you want to create.
public virtual object RowLevelPermissionDataSet { get; set; }
Property Value
System.Object
RowLevelPermissionTagConfiguration
The element you can use to define tags for row-level security.
public virtual object RowLevelPermissionTagConfiguration { get; set; }
Property Value
System.Object
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
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[]
Methods
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>