interface CfnDataSetProps

Language	Type name
.NET	`Amazon.CDK.AWS.QuickSight.CfnDataSetProps`
Java	`software.amazon.awscdk.services.quicksight.CfnDataSetProps`
Python	`aws_cdk.aws_quicksight.CfnDataSetProps`
TypeScript	`@aws-cdk/aws-quicksight` » `CfnDataSetProps`

Properties for defining a CfnDataSet.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as quicksight from '@aws-cdk/aws-quicksight';

declare const tagRuleConfigurations: any;
const cfnDataSetProps: quicksight.CfnDataSetProps = {
  awsAccountId: 'awsAccountId',
  columnGroups: [{
    geoSpatialColumnGroup: {
      columns: ['columns'],
      name: 'name',

      // the properties below are optional
      countryCode: 'countryCode',
    },
  }],
  columnLevelPermissionRules: [{
    columnNames: ['columnNames'],
    principals: ['principals'],
  }],
  dataSetId: 'dataSetId',
  datasetParameters: [{
    dateTimeDatasetParameter: {
      id: 'id',
      name: 'name',
      valueType: 'valueType',

      // the properties below are optional
      defaultValues: {
        staticValues: ['staticValues'],
      },
      timeGranularity: 'timeGranularity',
    },
    decimalDatasetParameter: {
      id: 'id',
      name: 'name',
      valueType: 'valueType',

      // the properties below are optional
      defaultValues: {
        staticValues: [123],
      },
    },
    integerDatasetParameter: {
      id: 'id',
      name: 'name',
      valueType: 'valueType',

      // the properties below are optional
      defaultValues: {
        staticValues: [123],
      },
    },
    stringDatasetParameter: {
      id: 'id',
      name: 'name',
      valueType: 'valueType',

      // the properties below are optional
      defaultValues: {
        staticValues: ['staticValues'],
      },
    },
  }],
  dataSetRefreshProperties: {
    refreshConfiguration: {
      incrementalRefresh: {
        lookbackWindow: {
          columnName: 'columnName',
          size: 123,
          sizeUnit: 'sizeUnit',
        },
      },
    },
  },
  dataSetUsageConfiguration: {
    disableUseAsDirectQuerySource: false,
    disableUseAsImportedSource: false,
  },
  fieldFolders: {
    fieldFoldersKey: {
      columns: ['columns'],
      description: 'description',
    },
  },
  importMode: 'importMode',
  ingestionWaitPolicy: {
    ingestionWaitTimeInHours: 123,
    waitForSpiceIngestion: false,
  },
  logicalTableMap: {
    logicalTableMapKey: {
      alias: 'alias',
      source: {
        dataSetArn: 'dataSetArn',
        joinInstruction: {
          leftOperand: 'leftOperand',
          onClause: 'onClause',
          rightOperand: 'rightOperand',
          type: 'type',

          // the properties below are optional
          leftJoinKeyProperties: {
            uniqueKey: false,
          },
          rightJoinKeyProperties: {
            uniqueKey: false,
          },
        },
        physicalTableId: 'physicalTableId',
      },

      // the properties below are optional
      dataTransforms: [{
        castColumnTypeOperation: {
          columnName: 'columnName',
          newColumnType: 'newColumnType',

          // the properties below are optional
          format: 'format',
        },
        createColumnsOperation: {
          columns: [{
            columnId: 'columnId',
            columnName: 'columnName',
            expression: 'expression',
          }],
        },
        filterOperation: {
          conditionExpression: 'conditionExpression',
        },
        overrideDatasetParameterOperation: {
          parameterName: 'parameterName',

          // the properties below are optional
          newDefaultValues: {
            dateTimeStaticValues: ['dateTimeStaticValues'],
            decimalStaticValues: [123],
            integerStaticValues: [123],
            stringStaticValues: ['stringStaticValues'],
          },
          newParameterName: 'newParameterName',
        },
        projectOperation: {
          projectedColumns: ['projectedColumns'],
        },
        renameColumnOperation: {
          columnName: 'columnName',
          newColumnName: 'newColumnName',
        },
        tagColumnOperation: {
          columnName: 'columnName',
          tags: [{
            columnDescription: {
              text: 'text',
            },
            columnGeographicRole: 'columnGeographicRole',
          }],
        },
      }],
    },
  },
  name: 'name',
  permissions: [{
    actions: ['actions'],
    principal: 'principal',
  }],
  physicalTableMap: {
    physicalTableMapKey: {
      customSql: {
        columns: [{
          name: 'name',
          type: 'type',
        }],
        dataSourceArn: 'dataSourceArn',
        name: 'name',
        sqlQuery: 'sqlQuery',
      },
      relationalTable: {
        dataSourceArn: 'dataSourceArn',
        inputColumns: [{
          name: 'name',
          type: 'type',
        }],
        name: 'name',

        // the properties below are optional
        catalog: 'catalog',
        schema: 'schema',
      },
      s3Source: {
        dataSourceArn: 'dataSourceArn',
        inputColumns: [{
          name: 'name',
          type: 'type',
        }],

        // the properties below are optional
        uploadSettings: {
          containsHeader: false,
          delimiter: 'delimiter',
          format: 'format',
          startFromRow: 123,
          textQualifier: 'textQualifier',
        },
      },
    },
  },
  rowLevelPermissionDataSet: {
    arn: 'arn',
    permissionPolicy: 'permissionPolicy',

    // the properties below are optional
    formatVersion: 'formatVersion',
    namespace: 'namespace',
    status: 'status',
  },
  rowLevelPermissionTagConfiguration: {
    tagRules: [{
      columnName: 'columnName',
      tagKey: 'tagKey',

      // the properties below are optional
      matchAllValue: 'matchAllValue',
      tagMultiValueDelimiter: 'tagMultiValueDelimiter',
    }],

    // the properties below are optional
    status: 'status',
    tagRuleConfigurations: tagRuleConfigurations,
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
awsAccountId?	`string`	The AWS account ID.
columnGroups?	`IResolvable` `\|` `IResolvable` `\|` `ColumnGroupProperty[]`	Groupings of columns that work together in certain Amazon QuickSight features.
columnLevelPermissionRules?	`IResolvable` `\|` `IResolvable` `\|` `ColumnLevelPermissionRuleProperty[]`	A set of one or more definitions of a `ColumnLevelPermissionRule` .
dataSetId?	`string`	An ID for the dataset that you want to create.
dataSetRefreshProperties?	`IResolvable` `\|` `DataSetRefreshPropertiesProperty`	`AWS::QuickSight::DataSet.DataSetRefreshProperties`.
dataSetUsageConfiguration?	`IResolvable` `\|` `DataSetUsageConfigurationProperty`	The usage configuration to apply to child datasets that reference this dataset as a source.
datasetParameters?	`IResolvable` `\|` `IResolvable` `\|` `DatasetParameterProperty[]`	`AWS::QuickSight::DataSet.DatasetParameters`.
fieldFolders?	`IResolvable` `\| { [string]:` `IResolvable` `\|` `FieldFolderProperty` `}`	The folder that contains fields and nested subfolders for your dataset.
importMode?	`string`	Indicates whether you want to import the data into SPICE.
ingestionWaitPolicy?	`IResolvable` `\|` `IngestionWaitPolicyProperty`	The wait policy to use when creating or updating a Dataset.
logicalTableMap?	`IResolvable` `\| { [string]:` `IResolvable` `\|` `LogicalTableProperty` `}`	Configures the combination and transformation of the data from the physical tables.
name?	`string`	The display name for the dataset.
permissions?	`IResolvable` `\|` `IResolvable` `\|` `ResourcePermissionProperty[]`	A list of resource permissions on the dataset.
physicalTableMap?	`IResolvable` `\| { [string]:` `IResolvable` `\|` `PhysicalTableProperty` `}`	Declares the physical tables that are available in the underlying data sources.
rowLevelPermissionDataSet?	`IResolvable` `\|` `RowLevelPermissionDataSetProperty`	The row-level security configuration for the data that you want to create.
rowLevelPermissionTagConfiguration?	`IResolvable` `\|` `RowLevelPermissionTagConfigurationProperty`	The element you can use to define tags for row-level security.
tags?	`CfnTag[]`	Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.