Class CfnTable.TableInputProperty

A structure used to define a table.

Inheritance

object

CfnTable.TableInputProperty

Implements

CfnTable.ITableInputProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Glue

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnTable.TableInputProperty : CfnTable.ITableInputProperty

Syntax (vb)

Public Class CfnTable.TableInputProperty Implements CfnTable.ITableInputProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.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.Glue;

             var parameters;
             var skewedColumnValueLocationMaps;

             var tableInputProperty = new TableInputProperty {
                 Description = "description",
                 Name = "name",
                 Owner = "owner",
                 Parameters = parameters,
                 PartitionKeys = new [] { new ColumnProperty {
                     Name = "name",

                     // the properties below are optional
                     Comment = "comment",
                     Type = "type"
                 } },
                 Retention = 123,
                 StorageDescriptor = new StorageDescriptorProperty {
                     BucketColumns = new [] { "bucketColumns" },
                     Columns = new [] { new ColumnProperty {
                         Name = "name",

                         // the properties below are optional
                         Comment = "comment",
                         Type = "type"
                     } },
                     Compressed = false,
                     InputFormat = "inputFormat",
                     Location = "location",
                     NumberOfBuckets = 123,
                     OutputFormat = "outputFormat",
                     Parameters = parameters,
                     SchemaReference = new SchemaReferenceProperty {
                         SchemaId = new SchemaIdProperty {
                             RegistryName = "registryName",
                             SchemaArn = "schemaArn",
                             SchemaName = "schemaName"
                         },
                         SchemaVersionId = "schemaVersionId",
                         SchemaVersionNumber = 123
                     },
                     SerdeInfo = new SerdeInfoProperty {
                         Name = "name",
                         Parameters = parameters,
                         SerializationLibrary = "serializationLibrary"
                     },
                     SkewedInfo = new SkewedInfoProperty {
                         SkewedColumnNames = new [] { "skewedColumnNames" },
                         SkewedColumnValueLocationMaps = skewedColumnValueLocationMaps,
                         SkewedColumnValues = new [] { "skewedColumnValues" }
                     },
                     SortColumns = new [] { new OrderProperty {
                         Column = "column",
                         SortOrder = 123
                     } },
                     StoredAsSubDirectories = false
                 },
                 TableType = "tableType",
                 TargetTable = new TableIdentifierProperty {
                     CatalogId = "catalogId",
                     DatabaseName = "databaseName",
                     Name = "name",
                     Region = "region"
                 },
                 ViewExpandedText = "viewExpandedText",
                 ViewOriginalText = "viewOriginalText"
             };

Synopsis

Constructors

TableInputProperty()

A structure used to define a table.

Properties

Description	A description of the table.
Name	The table name.
Owner	The table owner.
Parameters	These key-value pairs define properties associated with the table.
PartitionKeys	A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
Retention	The retention time for this table.
StorageDescriptor	A storage descriptor containing information about the physical storage of this table.
TableType	The type of this table.
TargetTable	A TableIdentifier structure that describes a target table for resource linking.
ViewExpandedText	Included for Apache Hive compatibility.
ViewOriginalText	Included for Apache Hive compatibility.

Constructors

TableInputProperty()

A structure used to define a table.

public TableInputProperty()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.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.Glue;

             var parameters;
             var skewedColumnValueLocationMaps;

             var tableInputProperty = new TableInputProperty {
                 Description = "description",
                 Name = "name",
                 Owner = "owner",
                 Parameters = parameters,
                 PartitionKeys = new [] { new ColumnProperty {
                     Name = "name",

                     // the properties below are optional
                     Comment = "comment",
                     Type = "type"
                 } },
                 Retention = 123,
                 StorageDescriptor = new StorageDescriptorProperty {
                     BucketColumns = new [] { "bucketColumns" },
                     Columns = new [] { new ColumnProperty {
                         Name = "name",

                         // the properties below are optional
                         Comment = "comment",
                         Type = "type"
                     } },
                     Compressed = false,
                     InputFormat = "inputFormat",
                     Location = "location",
                     NumberOfBuckets = 123,
                     OutputFormat = "outputFormat",
                     Parameters = parameters,
                     SchemaReference = new SchemaReferenceProperty {
                         SchemaId = new SchemaIdProperty {
                             RegistryName = "registryName",
                             SchemaArn = "schemaArn",
                             SchemaName = "schemaName"
                         },
                         SchemaVersionId = "schemaVersionId",
                         SchemaVersionNumber = 123
                     },
                     SerdeInfo = new SerdeInfoProperty {
                         Name = "name",
                         Parameters = parameters,
                         SerializationLibrary = "serializationLibrary"
                     },
                     SkewedInfo = new SkewedInfoProperty {
                         SkewedColumnNames = new [] { "skewedColumnNames" },
                         SkewedColumnValueLocationMaps = skewedColumnValueLocationMaps,
                         SkewedColumnValues = new [] { "skewedColumnValues" }
                     },
                     SortColumns = new [] { new OrderProperty {
                         Column = "column",
                         SortOrder = 123
                     } },
                     StoredAsSubDirectories = false
                 },
                 TableType = "tableType",
                 TargetTable = new TableIdentifierProperty {
                     CatalogId = "catalogId",
                     DatabaseName = "databaseName",
                     Name = "name",
                     Region = "region"
                 },
                 ViewExpandedText = "viewExpandedText",
                 ViewOriginalText = "viewOriginalText"
             };

Properties

Description

A description of the table.

public string? Description { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-description

Name

The table name.

public string? Name { get; set; }

Property Value

string

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-name

Owner

The table owner.

public string? Owner { get; set; }

Property Value

string

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-owner

Parameters

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

public object? Parameters { get; set; }

Property Value

object

Remarks

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

PartitionKeys

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

public object? PartitionKeys { get; set; }

Property Value

object

Remarks

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": []

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-partitionkeys

Retention

The retention time for this table.

public double? Retention { get; set; }

Property Value

double?

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-retention

StorageDescriptor

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

public object? StorageDescriptor { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-storagedescriptor

TableType

The type of this table.

public string? TableType { get; set; }

Property Value

string

Remarks

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:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-tabletype

TargetTable

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

public object? TargetTable { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-targettable

ViewExpandedText

Included for Apache Hive compatibility.

public string? ViewExpandedText { get; set; }

Property Value

string

Remarks

Not used in the normal course of AWS Glue operations.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-viewexpandedtext

ViewOriginalText

Included for Apache Hive compatibility.

public string? ViewOriginalText { get; set; }

Property Value

string

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-vieworiginaltext

Implements

CfnTable.ITableInputProperty