Class CfnDataSetProps
Properties for defining a CfnDataSet.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.QuickSight
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDataSetProps : Object, ICfnDataSetPropsSyntax (vb)
Public Class CfnDataSetProps
Inherits Object
Implements ICfnDataSetPropsRemarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html
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 cfnDataSetProps = 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"
} }
},
FolderArns = new [] { "folderArns" },
ImportMode = "importMode",
IngestionWaitPolicy = new IngestionWaitPolicyProperty {
IngestionWaitTimeInHours = 123,
WaitForSpiceIngestion = false
},
LogicalTableMap = new Dictionary<string, object> {
{ "logicalTableMapKey", new LogicalTableProperty {
Alias = "alias",
// 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"
} }
},
UntagColumnOperation = new UntagColumnOperationProperty {
ColumnName = "columnName",
TagNames = new [] { "tagNames" }
}
} },
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"
}
} }
},
Name = "name",
PerformanceConfiguration = new PerformanceConfigurationProperty {
UniqueKeys = new [] { new UniqueKeyProperty {
ColumnNames = new [] { "columnNames" }
} }
},
Permissions = new [] { new ResourcePermissionProperty {
Actions = new [] { "actions" },
Principal = "principal"
} },
PhysicalTableMap = new Dictionary<string, object> {
{ "physicalTableMapKey", new PhysicalTableProperty {
CustomSql = new CustomSqlProperty {
DataSourceArn = "dataSourceArn",
Name = "name",
SqlQuery = "sqlQuery",
// the properties below are optional
Columns = new [] { new InputColumnProperty {
Name = "name",
Type = "type",
// the properties below are optional
SubType = "subType"
} }
},
RelationalTable = new RelationalTableProperty {
DataSourceArn = "dataSourceArn",
Name = "name",
// the properties below are optional
Catalog = "catalog",
InputColumns = new [] { new InputColumnProperty {
Name = "name",
Type = "type",
// the properties below are optional
SubType = "subType"
} },
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
| Cfn |
Properties
| Aws |
The AWS account ID. |
| Column |
Groupings of columns that work together in certain Amazon QuickSight features. |
| Column |
A set of one or more definitions of a |
| Data |
An ID for the dataset that you want to create. |
| Dataset |
The parameters that are declared in a dataset. |
| Data |
The refresh properties of a dataset. |
| Data |
The usage configuration to apply to child datasets that reference this dataset as a source. |
| Field |
The folder that contains fields and nested subfolders for your dataset. |
| Folder |
<p>When you create the dataset, Amazon QuickSight adds the dataset to these folders.</p>. |
| Import |
Indicates whether you want to import the data into SPICE. |
| Ingestion |
The wait policy to use when creating or updating a Dataset. |
| Logical |
Configures the combination and transformation of the data from the physical tables. |
| Name | The display name for the dataset. |
| Performance |
The performance optimization configuration of a dataset. |
| Permissions | A list of resource permissions on the dataset. |
| Physical |
Declares the physical tables that are available in the underlying data sources. |
| Row |
The row-level security configuration for the data that you want to create. |
| Row |
The element you can use to define tags for row-level security. |
| Tags | Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset. |
Constructors
CfnDataSetProps()
public CfnDataSetProps()Properties
AwsAccountId
The AWS account ID.
public string AwsAccountId { get; set; }Property Value
System.
Remarks
ColumnGroups
Groupings of columns that work together in certain Amazon QuickSight features.
public object ColumnGroups { get; set; }Property Value
System.
Remarks
Currently, only geospatial hierarchy is supported.
ColumnLevelPermissionRules
A set of one or more definitions of a ColumnLevelPermissionRule .
public object ColumnLevelPermissionRules { get; set; }Property Value
System.
Remarks
DataSetId
An ID for the dataset that you want to create.
public string DataSetId { get; set; }Property Value
System.
Remarks
This ID is unique per AWS Region for each AWS account.
DatasetParameters
The parameters that are declared in a dataset.
public object DatasetParameters { get; set; }Property Value
System.
Remarks
DataSetRefreshProperties
The refresh properties of a dataset.
public object DataSetRefreshProperties { get; set; }Property Value
System.
Remarks
DataSetUsageConfiguration
The usage configuration to apply to child datasets that reference this dataset as a source.
public object DataSetUsageConfiguration { get; set; }Property Value
System.
Remarks
FieldFolders
The folder that contains fields and nested subfolders for your dataset.
public object FieldFolders { get; set; }Property Value
System.
Remarks
FolderArns
<p>When you create the dataset, Amazon QuickSight adds the dataset to these folders.</p>.
public string[] FolderArns { get; set; }Property Value
System.
Remarks
ImportMode
Indicates whether you want to import the data into SPICE.
public string ImportMode { get; set; }Property Value
System.
Remarks
IngestionWaitPolicy
The wait policy to use when creating or updating a Dataset.
public object IngestionWaitPolicy { get; set; }Property Value
System.
Remarks
The default is to wait for SPICE ingestion to finish with timeout of 36 hours.
LogicalTableMap
Configures the combination and transformation of the data from the physical tables.
public object LogicalTableMap { get; set; }Property Value
System.
Remarks
Name
The display name for the dataset.
public string Name { get; set; }Property Value
System.
Remarks
PerformanceConfiguration
The performance optimization configuration of a dataset.
public object PerformanceConfiguration { get; set; }Property Value
System.
Remarks
Permissions
A list of resource permissions on the dataset.
public object Permissions { get; set; }Property Value
System.
Remarks
PhysicalTableMap
Declares the physical tables that are available in the underlying data sources.
public object PhysicalTableMap { get; set; }Property Value
System.
Remarks
RowLevelPermissionDataSet
The row-level security configuration for the data that you want to create.
public object RowLevelPermissionDataSet { get; set; }Property Value
System.
Remarks
RowLevelPermissionTagConfiguration
The element you can use to define tags for row-level security.
public object RowLevelPermissionTagConfiguration { get; set; }Property Value
System.
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
ICfn