CatalogTableArgs class
The set of arguments for CatalogTable. The set of arguments for CatalogTable.
Constructors
-
CatalogTableArgs({Input<
String?> ? catalogId, required Input<String> databaseName, Input<String?> ? description, Input<String?> ? name, Input<CatalogTableOpenTableFormatInput?> ? openTableFormatInput, Input<String?> ? owner, Input<Map< ? parameters, Input<String, String> ?>List< ? partitionIndices, Input<CatalogTablePartitionIndex> ?>List< ? partitionKeys, Input<CatalogTablePartitionKey> ?>String?> ? region, Input<int?> ? retention, Input<CatalogTableStorageDescriptor?> ? storageDescriptor, Input<String?> ? tableType, Input<CatalogTableTargetTable?> ? targetTable, Input<CatalogTableViewDefinition?> ? viewDefinition, Input<String?> ? viewExpandedText, Input<String?> ? viewOriginalText}) -
Creates a new CatalogTableArgs.
catalogIdID of the Glue Catalog and database to create the table in. If omitted, this defaults to the AWS Account ID plus the database name.databaseNameName of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase.descriptionDescription of the table.nameName of the table. For Hive compatibility, this must be entirely lowercase.openTableFormatInputConfiguration block for open table formats. SeeopenTableFormatInputbelow.ownerOwner of the table.parametersProperties associated with this table, as a map of key-value pairs.partitionIndicesConfiguration block for a maximum of 3 partition indexes. SeepartitionIndexbelow.partitionKeysConfiguration block of columns by which the table is partitioned. Only primitive types are supported as partition keys. SeepartitionKeysbelow.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.retentionRetention time for this table.storageDescriptorConfiguration block for information about the physical storage of this table. For more information, refer to the Glue Developer Guide. SeestorageDescriptorbelow.tableTypeType of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.). While optional, some Athena DDL queries such asALTER TABLEandSHOW CREATE TABLEwill fail if this argument is empty.targetTableConfiguration block of a target table for resource linking. SeetargetTablebelow.viewDefinitionStructure that contains all the information that defines the view, including the dialect or dialects for the view, and the query. SeeviewDefinitionbelow.viewExpandedTextIf the table is a view, the expanded text of the view; otherwise null.viewOriginalTextIf the table is a view, the original text of the view; otherwise null.const -
CatalogTableArgs.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
catalogId
→ Input<
String?> ? -
ID of the Glue Catalog and database to create the table in. If omitted, this defaults to the AWS Account ID plus the database name.
final
-
databaseName
→ Input<
String> -
Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase.
final
-
description
→ Input<
String?> ? -
Description of the table.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
name
→ Input<
String?> ? -
Name of the table. For Hive compatibility, this must be entirely lowercase.
final
-
openTableFormatInput
→ Input<
CatalogTableOpenTableFormatInput?> ? -
Configuration block for open table formats. See
openTableFormatInputbelow.final -
owner
→ Input<
String?> ? -
Owner of the table.
final
-
parameters
→ Input<
Map< ?String, String> ?> -
Properties associated with this table, as a map of key-value pairs.
final
-
partitionIndices
→ Input<
List< ?CatalogTablePartitionIndex> ?> -
Configuration block for a maximum of 3 partition indexes. See
partitionIndexbelow.final -
partitionKeys
→ Input<
List< ?CatalogTablePartitionKey> ?> -
Configuration block of columns by which the table is partitioned. Only primitive types are supported as partition keys. See
partitionKeysbelow.final -
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
-
retention
→ Input<
int?> ? -
Retention time for this table.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
storageDescriptor
→ Input<
CatalogTableStorageDescriptor?> ? -
Configuration block for information about the physical storage of this table. For more information, refer to the Glue Developer Guide. See
storageDescriptorbelow.final -
tableType
→ Input<
String?> ? -
Type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.). While optional, some Athena DDL queries such as
ALTER TABLEandSHOW CREATE TABLEwill fail if this argument is empty.final -
targetTable
→ Input<
CatalogTableTargetTable?> ? -
Configuration block of a target table for resource linking. See
targetTablebelow.final -
viewDefinition
→ Input<
CatalogTableViewDefinition?> ? -
Structure that contains all the information that defines the view, including the dialect or dialects for the view, and the query. See
viewDefinitionbelow.final -
viewExpandedText
→ Input<
String?> ? -
If the table is a view, the expanded text of the view; otherwise null.
final
-
viewOriginalText
→ Input<
String?> ? -
If the table is a view, the original text of the view; otherwise null.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited