2.203.1

interface TableProps 🔹

LanguageType name
.NETAmazon.CDK.AWS.Glue.Alpha.TableProps
Gogithub.com/aws/aws-cdk-go/awscdkgluealpha/v2#TableProps
Javasoftware.amazon.awscdk.services.glue.alpha.TableProps
Pythonaws_cdk.aws_glue_alpha.TableProps
TypeScript (source)@aws-cdk/aws-glue-alpha » TableProps

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as glue_alpha from '@aws-cdk/aws-glue-alpha';
import { aws_kms as kms } from 'aws-cdk-lib';
import { aws_s3 as s3 } from 'aws-cdk-lib';

declare const bucket: s3.Bucket;
declare const database: glue_alpha.Database;
declare const dataFormat: glue_alpha.DataFormat;
declare const key: kms.Key;
declare const storageParameter: glue_alpha.StorageParameter;
const tableProps: glue_alpha.TableProps = {
  columns: [{
    name: 'name',
    type: {
      inputString: 'inputString',
      isPrimitive: false,
    },

    // the properties below are optional
    comment: 'comment',
  }],
  database: database,
  dataFormat: dataFormat,

  // the properties below are optional
  bucket: bucket,
  compressed: false,
  description: 'description',
  enablePartitionFiltering: false,
  encryption: glue_alpha.TableEncryption.S3_MANAGED,
  encryptionKey: key,
  parameters: {
    parametersKey: 'parameters',
  },
  partitionIndexes: [{
    keyNames: ['keyNames'],

    // the properties below are optional
    indexName: 'indexName',
  }],
  partitionKeys: [{
    name: 'name',
    type: {
      inputString: 'inputString',
      isPrimitive: false,
    },

    // the properties below are optional
    comment: 'comment',
  }],
  s3Prefix: 's3Prefix',
  storageParameters: [storageParameter],
  storedAsSubDirectories: false,
  tableName: 'tableName',
};

Properties

NameTypeDescription
columns🔹Column[]Columns of the table.
dataFormat🔹DataFormatStorage type of the table's data.
database🔹IDatabaseDatabase in which to store the table.
bucket?🔹IBucketS3 bucket in which to store data.
compressed?🔹booleanIndicates whether the table's data is compressed or not.
description?🔹stringDescription of the table.
enablePartitionFiltering?🔹booleanEnables partition filtering.
encryption?🔹TableEncryptionThe kind of encryption to secure the data with.
encryptionKey?🔹IKeyExternal KMS key to use for bucket encryption.
parameters?🔹{ [string]: string }The key/value pairs define properties associated with the table.
partitionIndexes?🔹PartitionIndex[]Partition indexes on the table.
partitionKeys?🔹Column[]Partition columns of the table.
s3Prefix?🔹stringS3 prefix under which table objects are stored.
storageParameters?🔹StorageParameter[]The user-supplied properties for the description of the physical storage of this table.
storedAsSubDirectories?🔹booleanIndicates whether the table data is stored in subdirectories.
tableName?🔹stringName of the table.

columns🔹

Type: Column[]

Columns of the table.

dataFormat🔹

Type: DataFormat

Storage type of the table's data.

database🔹

Type: IDatabase

Database in which to store the table.

bucket?🔹

Type: IBucket (optional, default: one is created for you)

S3 bucket in which to store data.

compressed?🔹

Type: boolean (optional, default: false)

Indicates whether the table's data is compressed or not.

description?🔹

Type: string (optional, default: generated)

Description of the table.

enablePartitionFiltering?🔹

Type: boolean (optional, default: The parameter is not defined)

Enables partition filtering.

See also: https://docs.aws.amazon.com/athena/latest/ug/glue-best-practices.html#glue-best-practices-partition-index

encryption?🔹

Type: TableEncryption (optional, default: BucketEncryption.S3_MANAGED)

The kind of encryption to secure the data with.

You can only provide this option if you are not explicitly passing in a bucket.

If you choose SSE-KMS, you can provide an un-managed KMS key with encryptionKey. If you choose CSE-KMS, you must provide an un-managed KMS key with encryptionKey.

encryptionKey?🔹

Type: IKey (optional, default: key is managed by KMS.)

External KMS key to use for bucket encryption.

The encryption property must be SSE-KMS or CSE-KMS.

parameters?🔹

Type: { [string]: string } (optional, default: The parameter is not defined)

The key/value pairs define properties associated with the table.

The key/value pairs that are allowed to be submitted are not limited, however their functionality is not guaranteed.

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-parameters

partitionIndexes?🔹

Type: PartitionIndex[] (optional, default: table has no partition indexes)

Partition indexes on the table.

A maximum of 3 indexes are allowed on a table. Keys in the index must be part of the table's partition keys.

partitionKeys?🔹

Type: Column[] (optional, default: table is not partitioned)

Partition columns of the table.

s3Prefix?🔹

Type: string (optional, default: No prefix. The data will be stored under the root of the bucket.)

S3 prefix under which table objects are stored.

storageParameters?🔹

Type: StorageParameter[] (optional, default: The parameter is not defined)

The user-supplied properties for the description of the physical storage of this table.

These properties help describe the format of the data that is stored within the crawled data sources.

The key/value pairs that are allowed to be submitted are not limited, however their functionality is not guaranteed.

Some keys will be auto-populated by glue crawlers, however, you can override them by specifying the key and value in this property.

See also: [https://docs.aws.amazon.com/redshift/latest/dg/r_CREATE_EXTERNAL_TABLE.html#r_CREATE_EXTERNAL_TABLE-parameters - under "TABLE PROPERTIES"](https://docs.aws.amazon.com/redshift/latest/dg/r_CREATE_EXTERNAL_TABLE.html#r_CREATE_EXTERNAL_TABLE-parameters - under "TABLE PROPERTIES") Example

   declare const glueDatabase: glue.IDatabase;
   const table = new glue.Table(this, 'Table', {
     storageParameters: [
         glue.StorageParameter.skipHeaderLineCount(1),
         glue.StorageParameter.compressionType(glue.CompressionType.GZIP),
         glue.StorageParameter.custom('foo', 'bar'), // Will have no effect
         glue.StorageParameter.custom('separatorChar', ','), // Will describe the separator char used in the data
         glue.StorageParameter.custom(glue.StorageParameters.WRITE_PARALLEL, 'off'),
     ],
     // ...
     database: glueDatabase,
     columns: [{
         name: 'col1',
         type: glue.Schema.STRING,
     }],
     dataFormat: glue.DataFormat.CSV,
   });

storedAsSubDirectories?🔹

Type: boolean (optional, default: false)

Indicates whether the table data is stored in subdirectories.

tableName?🔹

Type: string (optional, default: generated by CDK.)

Name of the table.

← PreviousNext →