AWS::Glue::Table TableInput

A structure used to define a table.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Description" : String,
  "Name" : String,
  "Owner" : String,
  "Parameters" : Json,
  "PartitionKeys" : [ Column, ... ],
  "Retention" : Integer,
  "StorageDescriptor" : StorageDescriptor,
  "TableType" : String,
  "TargetTable" : TableIdentifier,
  "ViewExpandedText" : String,
  "ViewOriginalText" : String
}

YAML

  Description: String
  Name: String
  Owner: String
  Parameters: Json
  PartitionKeys: 
    - Column
  Retention: Integer
  StorageDescriptor: 
    StorageDescriptor
  TableType: String
  TargetTable: 
    TableIdentifier
  ViewExpandedText: String
  ViewOriginalText: String

Properties

Description

A description of the table.

Required: No

Type: String

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Minimum: 0

Maximum: 2048

Update requires: No interruption

Name

The table name. For Hive compatibility, this is folded to lowercase when it is stored.

Required: No

Type: String

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Minimum: 1

Maximum: 255

Update requires: No interruption

Owner

The table owner. Included for Apache Hive compatibility. Not used in the normal course of AWS Glue operations.

Required: No

Type: String

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Minimum: 1

Maximum: 255

Update requires: No interruption

Parameters

These key-value pairs define properties associated with the table.

Required: No

Type: Json

Update requires: No interruption

PartitionKeys

A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.

When you create a table used by Amazon Athena, and you do not specify any partitionKeys, you must at least set the value of partitionKeys to an empty list. For example:

"PartitionKeys": []

Required: No

Type: Array of Column

Update requires: No interruption

Retention

The retention time for this table.

Required: No

Type: Integer

Minimum: 0

Update requires: No interruption

StorageDescriptor

A storage descriptor containing information about the physical storage of this table.

Required: No

Type: StorageDescriptor

Update requires: No interruption

TableType

The type of this table. AWS Glue will create tables with the EXTERNAL_TABLE type. Other services, such as Athena, may create tables with additional table types.

AWS Glue related table types:

EXTERNAL_TABLE

Hive compatible attribute - indicates a non-Hive managed table.

GOVERNED

Used by AWS Lake Formation. The AWS Glue Data Catalog understands GOVERNED.

Required: No

Type: String

Maximum: 255

Update requires: No interruption

TargetTable

A TableIdentifier structure that describes a target table for resource linking.

Required: No

Type: TableIdentifier

Update requires: No interruption

ViewExpandedText

Included for Apache Hive compatibility. Not used in the normal course of AWS Glue operations.

Required: No

Type: String

Maximum: 409600

Update requires: No interruption

ViewOriginalText

Included for Apache Hive compatibility. Not used in the normal course of AWS Glue operations. If the table is a VIRTUAL_VIEW, certain Athena configuration encoded in base64.

Required: No

Type: String

Maximum: 409600

Update requires: No interruption