DataSet
quicksight.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | quicksight-controller/apis/v1alpha1#DataSet |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | DataSet |
| ListKind | DataSetList |
| Plural | datasets |
| Singular | dataset |
Dataset.
Spec
awsAccountID: string
columnGroups:
geoSpatialColumnGroup:
columns:
- string
countryCode: string
name: string
columnLevelPermissionRules:
columnNames:
- string
principals:
- string
dataPrepConfiguration:
destinationTableMap: {}
sourceTableMap: {}
transformStepMap: {}
fieldFolders: {}
folderARNs:
- string
id: string
importMode: string
name: string
parameters:
dateTimeDatasetParameter:
defaultValues:
staticValues:
- string
id: string
name: string
timeGranularity: string
valueType: string
decimalDatasetParameter:
defaultValues:
staticValues:
- number
id: string
name: string
valueType: string
integerDatasetParameter:
defaultValues:
staticValues:
- integer
id: string
name: string
valueType: string
stringDatasetParameter:
defaultValues:
staticValues:
- string
id: string
name: string
valueType: string
performanceConfiguration:
uniqueKeys:
columnNames:
- string
permissions:
actions:
- string
principal: string
physicalTableMap: {}
semanticModelConfiguration:
tableMap: {}
tags:
- key: string
value: string
usageConfiguration:
disableUseAsDirectQuerySource: boolean
disableUseAsImportedSource: boolean
useAs: string
| Field | Description |
|---|---|
| awsAccountID Required | string The Amazon Web Services account ID. Regex Pattern: ^[0-9]{12}$ |
| columnGroups Optional | array Groupings of columns that work together in certain Amazon Quick Sight features. Currently, only geospatial hierarchy is supported. |
| columnGroups.[] Required | object Groupings of columns that work together in certain Quick Sight features. |
| This is a variant type structure. For this structure to be valid, only one | |
| of the attributes can be non-null. | |
| columnGroups.[].geoSpatialColumnGroup.columns Optional | array |
| columnGroups.[].geoSpatialColumnGroup.columns.[] Required | string |
| columnGroups.[].geoSpatialColumnGroup.name Optional | string |
| columnLevelPermissionRules Optional | array A set of one or more definitions of a ColumnLevelPermissionRule (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_ColumnLevelPermissionRule.html) . |
| columnLevelPermissionRules.[] Required | object A rule defined to grant access on one or more restricted columns. Each dataset |
| can have multiple rules. To create a restricted column, you add it to one | |
| or more rules. Each rule must contain at least one column and at least one | |
| user or group. To be able to see a restricted column, a user or group needs | |
| to be added to a rule for that column. | |
| columnLevelPermissionRules.[].columnNames.[] Required | string |
| columnLevelPermissionRules.[].principals.[] Required | string |
| dataPrepConfiguration.destinationTableMap Optional | object |
| dataPrepConfiguration.sourceTableMap Optional | object |
| dataPrepConfiguration.transformStepMap Optional | object |
| fieldFolders Optional | object The folder that contains fields and nested subfolders for your dataset. |
| folderARNs Optional | array When you create the dataset, Amazon Quick Sight adds the dataset to these folders. |
| folderARNs.[] Required | string |
| importMode Required | string Indicates whether you want to import the data into SPICE. |
| name Required | string The display name for the dataset. |
| parameters Optional | array The parameter declarations of the dataset. |
| parameters.[] Required | object A parameter that is created in a dataset. The parameter can be a string, |
| integer, decimal, or datetime data type. | |
| parameters.[].dateTimeDatasetParameter.defaultValues Optional | object The default values of a date time parameter. |
| parameters.[].dateTimeDatasetParameter.defaultValues.staticValues Optional | array |
| parameters.[].dateTimeDatasetParameter.defaultValues.staticValues.[] Required | string |
| parameters.[].dateTimeDatasetParameter.name Optional | string |
| parameters.[].dateTimeDatasetParameter.timeGranularity Optional | string |
| parameters.[].dateTimeDatasetParameter.valueType Optional | string The value type of the parameter. The value type is used to validate the parameter before it is evaluated. |
| parameters.[].decimalDatasetParameter Optional | object A decimal parameter for a dataset. |
| parameters.[].decimalDatasetParameter.defaultValues Optional | object The default values of a decimal parameter. |
| parameters.[].decimalDatasetParameter.defaultValues.staticValues Optional | array |
| parameters.[].decimalDatasetParameter.defaultValues.staticValues.[] Required | number |
| parameters.[].decimalDatasetParameter.name Optional | string |
| parameters.[].decimalDatasetParameter.valueType Optional | string The value type of the parameter. The value type is used to validate the parameter before it is evaluated. |
| parameters.[].integerDatasetParameter Optional | object An integer parameter for a dataset. |
| parameters.[].integerDatasetParameter.defaultValues Optional | object The default values of an integer parameter. |
| parameters.[].integerDatasetParameter.defaultValues.staticValues Optional | array |
| parameters.[].integerDatasetParameter.defaultValues.staticValues.[] Required | integer |
| parameters.[].integerDatasetParameter.name Optional | string |
| parameters.[].integerDatasetParameter.valueType Optional | string The value type of the parameter. The value type is used to validate the parameter before it is evaluated. |
| parameters.[].stringDatasetParameter Optional | object A string parameter for a dataset. |
| parameters.[].stringDatasetParameter.defaultValues Optional | object The default values of a string parameter. |
| parameters.[].stringDatasetParameter.defaultValues.staticValues Optional | array |
| parameters.[].stringDatasetParameter.defaultValues.staticValues.[] Required | string |
| parameters.[].stringDatasetParameter.name Optional | string |
| parameters.[].stringDatasetParameter.valueType Optional | string The value type of the parameter. The value type is used to validate the parameter before it is evaluated. |
| performanceConfiguration Optional | object The configuration for the performance optimization of the dataset that contains a UniqueKey configuration. |
| performanceConfiguration.uniqueKeys Optional | array |
| performanceConfiguration.uniqueKeys.[] Required | object A UniqueKey configuration that references a dataset column. |
| performanceConfiguration.uniqueKeys.[].columnNames.[] Required | string |
| permissions.[] Required | object Permission for the resource. |
| permissions.[].actions.[] Required | string |
| physicalTableMap Required | object Declares the physical tables that are available in the underlying data sources. |
| semanticModelConfiguration Optional | object The semantic model configuration for the dataset. This configuration defines how the prepared data is structured for an analysis, including table mappings and row-level security configurations. Required when using the new data preparation experience. |
| semanticModelConfiguration.tableMap Optional | object |
| tags Optional | array Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset. |
| tags.[] Required | object The key or keys of the key-value pairs for the resource tag or tags assigned |
| to the resource. | |
| tags.[].value Optional | string |
| usageConfiguration Optional | object The usage configuration to apply to child datasets that reference this dataset as a source. |
| usageConfiguration.disableUseAsDirectQuerySource Optional | boolean |
| usageConfiguration.disableUseAsImportedSource Optional | boolean |
| useAs Optional | string The usage of the dataset. RLS_RULES must be specified for RLS permission datasets. |
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
partition: string
region: string
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
consumedSpiceCapacityInBytes: integer
createdTime: string
ingestionARN: string
ingestionID: string
lastUpdatedTime: string
outputColumns:
- description: string
id: string
name: string
subType: string
type: string
| Field | Description |
|---|---|
| ackResourceMetadata Optional | object All CRs managed by ACK have a common Status.ACKResourceMetadata memberthat is used to contain resource sync state, account ownership, constructed ARN for the resource |
| ackResourceMetadata.arn Optional | string ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. https://github.com/aws/aws-controllers-k8s/issues/270 |
| ackResourceMetadata.ownerAccountID Required | string OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource. |
| ackResourceMetadata.partition Optional | string Partition is the AWS partition in which the resource exists or will exist |
| ackResourceMetadata.region Required | string Region is the AWS region in which the resource exists or will exist. |
| conditions Optional | array All CRs managed by ACK have a common Status.Conditions member thatcontains a collection of ackv1alpha1.Condition objects that describethe various terminal states of the CR and its backend AWS service API resource |
| conditions.[] Required | object Condition is the common struct used by all CRDs managed by ACK service |
| controllers to indicate terminal states of the CR and its backend AWS | |
| service API resource | |
| conditions.[].message Optional | string A human readable message indicating details about the transition. |
| conditions.[].reason Optional | string The reason for the condition’s last transition. |
| conditions.[].status Optional | string Status of the condition, one of True, False, Unknown. |
| conditions.[].type Optional | string Type is the type of the Condition |
| consumedSpiceCapacityInBytes Optional | integer The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn’t imported into SPICE. |
| createdTime Optional | string The time that this dataset was created. |
| ingestionARN Optional | string The ARN for the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE. |
| ingestionID Optional | string The ID of the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE. |
| lastUpdatedTime Optional | string The last time that this dataset was updated. |
| outputColumns Optional | array The list of columns after all transforms. These columns are available in templates, analyses, and dashboards. |
| outputColumns.[] Required | object Output column. |
| outputColumns.[].id Optional | string |
| outputColumns.[].name Optional | string |
| outputColumns.[].subType Optional | string |
| outputColumns.[].type Optional | string |