We recommend new projects start with resources from the AWS provider.
We recommend new projects start with resources from the AWS provider.
Resource Type definition for AWS::S3Tables::Table
Create Table Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Table(name: string, args: TableArgs, opts?: CustomResourceOptions);@overload
def Table(resource_name: str,
args: TableArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Table(resource_name: str,
opts: Optional[ResourceOptions] = None,
namespace: Optional[str] = None,
open_table_format: Optional[TableOpenTableFormat] = None,
table_bucket_arn: Optional[str] = None,
compaction: Optional[TableCompactionArgs] = None,
iceberg_metadata: Optional[TableIcebergMetadataArgs] = None,
snapshot_management: Optional[TableSnapshotManagementArgs] = None,
storage_class_configuration: Optional[TableStorageClassConfigurationArgs] = None,
table_name: Optional[str] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
without_metadata: Optional[TableWithoutMetadata] = None)func NewTable(ctx *Context, name string, args TableArgs, opts ...ResourceOption) (*Table, error)public Table(string name, TableArgs args, CustomResourceOptions? opts = null)type: aws-native:s3tables:Table
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args TableArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args TableArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args TableArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args TableArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args TableArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Table Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Table resource accepts the following input properties:
- Namespace string
- The name of the namespace.
- Open
Table Pulumi.Format Aws Native. S3Tables. Table Open Table Format - The format of the table.
- Table
Bucket stringArn - The Amazon Resource Name (ARN) of the table bucket to create the table in.
- Compaction
Pulumi.
Aws Native. S3Tables. Inputs. Table Compaction - Contains details about the compaction settings for an Iceberg table.
- Iceberg
Metadata Pulumi.Aws Native. S3Tables. Inputs. Table Iceberg Metadata - Contains details about the metadata for an Iceberg table.
- Snapshot
Management Pulumi.Aws Native. S3Tables. Inputs. Table Snapshot Management - Contains details about the Iceberg snapshot management settings for the table.
- Storage
Class Pulumi.Configuration Aws Native. S3Tables. Inputs. Table Storage Class Configuration - The configuration details for the storage class of tables or table buckets. This allows you to optimize storage costs by selecting the appropriate storage class based on your access patterns and performance requirements.
- Table
Name string - The name for the table.
-
List<Pulumi.
Aws Native. Inputs. Tag> - User tags (key-value pairs) to associate with the table.
- Without
Metadata Pulumi.Aws Native. S3Tables. Table Without Metadata - Indicates that you don't want to specify a schema for the table. This property is mutually exclusive to
IcebergMetadata, and its only possible value isYes.
- Namespace string
- The name of the namespace.
- Open
Table TableFormat Open Table Format - The format of the table.
- Table
Bucket stringArn - The Amazon Resource Name (ARN) of the table bucket to create the table in.
- Compaction
Table
Compaction Args - Contains details about the compaction settings for an Iceberg table.
- Iceberg
Metadata TableIceberg Metadata Args - Contains details about the metadata for an Iceberg table.
- Snapshot
Management TableSnapshot Management Args - Contains details about the Iceberg snapshot management settings for the table.
- Storage
Class TableConfiguration Storage Class Configuration Args - The configuration details for the storage class of tables or table buckets. This allows you to optimize storage costs by selecting the appropriate storage class based on your access patterns and performance requirements.
- Table
Name string - The name for the table.
-
Tag
Args - User tags (key-value pairs) to associate with the table.
- Without
Metadata TableWithout Metadata - Indicates that you don't want to specify a schema for the table. This property is mutually exclusive to
IcebergMetadata, and its only possible value isYes.
- namespace String
- The name of the namespace.
- open
Table TableFormat Open Table Format - The format of the table.
- table
Bucket StringArn - The Amazon Resource Name (ARN) of the table bucket to create the table in.
- compaction
Table
Compaction - Contains details about the compaction settings for an Iceberg table.
- iceberg
Metadata TableIceberg Metadata - Contains details about the metadata for an Iceberg table.
- snapshot
Management TableSnapshot Management - Contains details about the Iceberg snapshot management settings for the table.
- storage
Class TableConfiguration Storage Class Configuration - The configuration details for the storage class of tables or table buckets. This allows you to optimize storage costs by selecting the appropriate storage class based on your access patterns and performance requirements.
- table
Name String - The name for the table.
- List<Tag>
- User tags (key-value pairs) to associate with the table.
- without
Metadata TableWithout Metadata - Indicates that you don't want to specify a schema for the table. This property is mutually exclusive to
IcebergMetadata, and its only possible value isYes.
- namespace string
- The name of the namespace.
- open
Table TableFormat Open Table Format - The format of the table.
- table
Bucket stringArn - The Amazon Resource Name (ARN) of the table bucket to create the table in.
- compaction
Table
Compaction - Contains details about the compaction settings for an Iceberg table.
- iceberg
Metadata TableIceberg Metadata - Contains details about the metadata for an Iceberg table.
- snapshot
Management TableSnapshot Management - Contains details about the Iceberg snapshot management settings for the table.
- storage
Class TableConfiguration Storage Class Configuration - The configuration details for the storage class of tables or table buckets. This allows you to optimize storage costs by selecting the appropriate storage class based on your access patterns and performance requirements.
- table
Name string - The name for the table.
- Tag[]
- User tags (key-value pairs) to associate with the table.
- without
Metadata TableWithout Metadata - Indicates that you don't want to specify a schema for the table. This property is mutually exclusive to
IcebergMetadata, and its only possible value isYes.
- namespace str
- The name of the namespace.
- open_
table_ Tableformat Open Table Format - The format of the table.
- table_
bucket_ strarn - The Amazon Resource Name (ARN) of the table bucket to create the table in.
- compaction
Table
Compaction Args - Contains details about the compaction settings for an Iceberg table.
- iceberg_
metadata TableIceberg Metadata Args - Contains details about the metadata for an Iceberg table.
- snapshot_
management TableSnapshot Management Args - Contains details about the Iceberg snapshot management settings for the table.
- storage_
class_ Tableconfiguration Storage Class Configuration Args - The configuration details for the storage class of tables or table buckets. This allows you to optimize storage costs by selecting the appropriate storage class based on your access patterns and performance requirements.
- table_
name str - The name for the table.
-
Sequence[Tag
Args] - User tags (key-value pairs) to associate with the table.
- without_
metadata TableWithout Metadata - Indicates that you don't want to specify a schema for the table. This property is mutually exclusive to
IcebergMetadata, and its only possible value isYes.
- namespace String
- The name of the namespace.
- open
Table "ICEBERG"Format - The format of the table.
- table
Bucket StringArn - The Amazon Resource Name (ARN) of the table bucket to create the table in.
- compaction Property Map
- Contains details about the compaction settings for an Iceberg table.
- iceberg
Metadata Property Map - Contains details about the metadata for an Iceberg table.
- snapshot
Management Property Map - Contains details about the Iceberg snapshot management settings for the table.
- storage
Class Property MapConfiguration - The configuration details for the storage class of tables or table buckets. This allows you to optimize storage costs by selecting the appropriate storage class based on your access patterns and performance requirements.
- table
Name String - The name for the table.
- List<Property Map>
- User tags (key-value pairs) to associate with the table.
- without
Metadata "Yes" - Indicates that you don't want to specify a schema for the table. This property is mutually exclusive to
IcebergMetadata, and its only possible value isYes.
Outputs
All input properties are implicitly available as output properties. Additionally, the Table resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Table
Arn string - The Amazon Resource Name (ARN) of the table.
- Version
Token string - The version token of the table.
- Warehouse
Location string - The warehouse location of the table.
- Id string
- The provider-assigned unique ID for this managed resource.
- Table
Arn string - The Amazon Resource Name (ARN) of the table.
- Version
Token string - The version token of the table.
- Warehouse
Location string - The warehouse location of the table.
- id String
- The provider-assigned unique ID for this managed resource.
- table
Arn String - The Amazon Resource Name (ARN) of the table.
- version
Token String - The version token of the table.
- warehouse
Location String - The warehouse location of the table.
- id string
- The provider-assigned unique ID for this managed resource.
- table
Arn string - The Amazon Resource Name (ARN) of the table.
- version
Token string - The version token of the table.
- warehouse
Location string - The warehouse location of the table.
- id str
- The provider-assigned unique ID for this managed resource.
- table_
arn str - The Amazon Resource Name (ARN) of the table.
- version_
token str - The version token of the table.
- warehouse_
location str - The warehouse location of the table.
- id String
- The provider-assigned unique ID for this managed resource.
- table
Arn String - The Amazon Resource Name (ARN) of the table.
- version
Token String - The version token of the table.
- warehouse
Location String - The warehouse location of the table.
Supporting Types
TableCompaction, TableCompactionArgs
Settings governing the Compaction maintenance action. Contains details about the compaction settings for an Iceberg table.- Status
Pulumi.
Aws Native. S3Tables. Table Compaction Status - Indicates whether the Compaction maintenance action is enabled.
- Target
File intSize Mb - The target file size for the table in MB.
- Status
Table
Compaction Status - Indicates whether the Compaction maintenance action is enabled.
- Target
File intSize Mb - The target file size for the table in MB.
- status
Table
Compaction Status - Indicates whether the Compaction maintenance action is enabled.
- target
File IntegerSize Mb - The target file size for the table in MB.
- status
Table
Compaction Status - Indicates whether the Compaction maintenance action is enabled.
- target
File numberSize Mb - The target file size for the table in MB.
- status
Table
Compaction Status - Indicates whether the Compaction maintenance action is enabled.
- target_
file_ intsize_ mb - The target file size for the table in MB.
- status "enabled" | "disabled"
- Indicates whether the Compaction maintenance action is enabled.
- target
File NumberSize Mb - The target file size for the table in MB.
TableCompactionStatus, TableCompactionStatusArgs
- Enabled
enabled- Disabled
disabled
- Table
Compaction Status Enabled enabled- Table
Compaction Status Disabled disabled
- Enabled
enabled- Disabled
disabled
- Enabled
enabled- Disabled
disabled
- ENABLED
enabled- DISABLED
disabled
- "enabled"
enabled- "disabled"
disabled
TableIcebergMetadata, TableIcebergMetadataArgs
Contains details about the metadata for an Iceberg table.- Iceberg
Schema Pulumi.Aws Native. S3Tables. Inputs. Table Iceberg Schema - The schema for an Iceberg table.
- Iceberg
Partition Pulumi.Spec Aws Native. S3Tables. Inputs. Table Iceberg Partition Spec - Iceberg
Sort Pulumi.Order Aws Native. S3Tables. Inputs. Table Iceberg Sort Order - Table
Properties Dictionary<string, string>
- Iceberg
Schema TableIceberg Schema - The schema for an Iceberg table.
- Iceberg
Partition TableSpec Iceberg Partition Spec - Iceberg
Sort TableOrder Iceberg Sort Order - Table
Properties map[string]string
- iceberg
Schema TableIceberg Schema - The schema for an Iceberg table.
- iceberg
Partition TableSpec Iceberg Partition Spec - iceberg
Sort TableOrder Iceberg Sort Order - table
Properties Map<String,String>
- iceberg
Schema TableIceberg Schema - The schema for an Iceberg table.
- iceberg
Partition TableSpec Iceberg Partition Spec - iceberg
Sort TableOrder Iceberg Sort Order - table
Properties {[key: string]: string}
- iceberg_
schema TableIceberg Schema - The schema for an Iceberg table.
- iceberg_
partition_ Tablespec Iceberg Partition Spec - iceberg_
sort_ Tableorder Iceberg Sort Order - table_
properties Mapping[str, str]
- iceberg
Schema Property Map - The schema for an Iceberg table.
- iceberg
Partition Property MapSpec - iceberg
Sort Property MapOrder - table
Properties Map<String>
TableIcebergPartitionField, TableIcebergPartitionFieldArgs
A partition field specification for an Iceberg tableTableIcebergPartitionSpec, TableIcebergPartitionSpecArgs
Partition specification for an Iceberg table- Fields
List<Pulumi.
Aws Native. S3Tables. Inputs. Table Iceberg Partition Field> - List of partition fields
- Spec
Id int - The partition spec ID (defaults to 0 if not specified)
- Fields
[]Table
Iceberg Partition Field - List of partition fields
- Spec
Id int - The partition spec ID (defaults to 0 if not specified)
- fields
List<Table
Iceberg Partition Field> - List of partition fields
- spec
Id Integer - The partition spec ID (defaults to 0 if not specified)
- fields
Table
Iceberg Partition Field[] - List of partition fields
- spec
Id number - The partition spec ID (defaults to 0 if not specified)
- fields
Sequence[Table
Iceberg Partition Field] - List of partition fields
- spec_
id int - The partition spec ID (defaults to 0 if not specified)
- fields List<Property Map>
- List of partition fields
- spec
Id Number - The partition spec ID (defaults to 0 if not specified)
TableIcebergSchema, TableIcebergSchemaArgs
Contains details about the schema for an Iceberg table- Schema
Field List<Pulumi.List Aws Native. S3Tables. Inputs. Table Schema Field> - The schema fields for the table
- Schema
Field []TableList Schema Field - The schema fields for the table
- schema
Field List<TableList Schema Field> - The schema fields for the table
- schema
Field TableList Schema Field[] - The schema fields for the table
- schema_
field_ Sequence[Tablelist Schema Field] - The schema fields for the table
- schema
Field List<Property Map>List - The schema fields for the table
TableIcebergSortField, TableIcebergSortFieldArgs
A sort field specification for an Iceberg table- Direction
Pulumi.
Aws Native. S3Tables. Table Iceberg Sort Field Direction - Sort direction (asc or desc)
- Null
Order Pulumi.Aws Native. S3Tables. Table Iceberg Sort Field Null Order - Null value ordering (nulls-first or nulls-last)
- Source
Id int - The source column ID to sort on
- Transform string
- The sort transform function
- Direction
Table
Iceberg Sort Field Direction - Sort direction (asc or desc)
- Null
Order TableIceberg Sort Field Null Order - Null value ordering (nulls-first or nulls-last)
- Source
Id int - The source column ID to sort on
- Transform string
- The sort transform function
- direction
Table
Iceberg Sort Field Direction - Sort direction (asc or desc)
- null
Order TableIceberg Sort Field Null Order - Null value ordering (nulls-first or nulls-last)
- source
Id Integer - The source column ID to sort on
- transform String
- The sort transform function
- direction
Table
Iceberg Sort Field Direction - Sort direction (asc or desc)
- null
Order TableIceberg Sort Field Null Order - Null value ordering (nulls-first or nulls-last)
- source
Id number - The source column ID to sort on
- transform string
- The sort transform function
- direction
Table
Iceberg Sort Field Direction - Sort direction (asc or desc)
- null_
order TableIceberg Sort Field Null Order - Null value ordering (nulls-first or nulls-last)
- source_
id int - The source column ID to sort on
- transform str
- The sort transform function
- direction "asc" | "desc"
- Sort direction (asc or desc)
- null
Order "nulls-first" | "nulls-last" - Null value ordering (nulls-first or nulls-last)
- source
Id Number - The source column ID to sort on
- transform String
- The sort transform function
TableIcebergSortFieldDirection, TableIcebergSortFieldDirectionArgs
- Asc
asc- Desc
desc
- Table
Iceberg Sort Field Direction Asc asc- Table
Iceberg Sort Field Direction Desc desc
- Asc
asc- Desc
desc
- Asc
asc- Desc
desc
- ASC
asc- DESC
desc
- "asc"
asc- "desc"
desc
TableIcebergSortFieldNullOrder, TableIcebergSortFieldNullOrderArgs
- Nulls
First nulls-first- Nulls
Last nulls-last
- Table
Iceberg Sort Field Null Order Nulls First nulls-first- Table
Iceberg Sort Field Null Order Nulls Last nulls-last
- Nulls
First nulls-first- Nulls
Last nulls-last
- Nulls
First nulls-first- Nulls
Last nulls-last
- NULLS_FIRST
nulls-first- NULLS_LAST
nulls-last
- "nulls-first"
nulls-first- "nulls-last"
nulls-last
TableIcebergSortOrder, TableIcebergSortOrderArgs
Sort order specification for an Iceberg table- Fields
List<Pulumi.
Aws Native. S3Tables. Inputs. Table Iceberg Sort Field> - List of sort fields
- Order
Id int - The sort order ID (defaults to 1 if not specified, 0 is reserved for unsorted)
- Fields
[]Table
Iceberg Sort Field - List of sort fields
- Order
Id int - The sort order ID (defaults to 1 if not specified, 0 is reserved for unsorted)
- fields
List<Table
Iceberg Sort Field> - List of sort fields
- order
Id Integer - The sort order ID (defaults to 1 if not specified, 0 is reserved for unsorted)
- fields
Table
Iceberg Sort Field[] - List of sort fields
- order
Id number - The sort order ID (defaults to 1 if not specified, 0 is reserved for unsorted)
- fields
Sequence[Table
Iceberg Sort Field] - List of sort fields
- order_
id int - The sort order ID (defaults to 1 if not specified, 0 is reserved for unsorted)
- fields List<Property Map>
- List of sort fields
- order
Id Number - The sort order ID (defaults to 1 if not specified, 0 is reserved for unsorted)
TableOpenTableFormat, TableOpenTableFormatArgs
- Iceberg
ICEBERG
- Table
Open Table Format Iceberg ICEBERG
- Iceberg
ICEBERG
- Iceberg
ICEBERG
- ICEBERG
ICEBERG
- "ICEBERG"
ICEBERG
TableSchemaField, TableSchemaFieldArgs
Contains details about the schema for an Iceberg tableTableSnapshotManagement, TableSnapshotManagementArgs
Contains details about the snapshot management settings for an Iceberg table. A snapshot is expired when it exceeds MinSnapshotsToKeep and MaxSnapshotAgeHours.- Max
Snapshot intAge Hours - The maximum age of a snapshot before it can be expired.
- Min
Snapshots intTo Keep - The minimum number of snapshots to keep.
- Status
Pulumi.
Aws Native. S3Tables. Table Snapshot Management Status - Indicates whether the SnapshotManagement maintenance action is enabled.
- Max
Snapshot intAge Hours - The maximum age of a snapshot before it can be expired.
- Min
Snapshots intTo Keep - The minimum number of snapshots to keep.
- Status
Table
Snapshot Management Status - Indicates whether the SnapshotManagement maintenance action is enabled.
- max
Snapshot IntegerAge Hours - The maximum age of a snapshot before it can be expired.
- min
Snapshots IntegerTo Keep - The minimum number of snapshots to keep.
- status
Table
Snapshot Management Status - Indicates whether the SnapshotManagement maintenance action is enabled.
- max
Snapshot numberAge Hours - The maximum age of a snapshot before it can be expired.
- min
Snapshots numberTo Keep - The minimum number of snapshots to keep.
- status
Table
Snapshot Management Status - Indicates whether the SnapshotManagement maintenance action is enabled.
- max_
snapshot_ intage_ hours - The maximum age of a snapshot before it can be expired.
- min_
snapshots_ intto_ keep - The minimum number of snapshots to keep.
- status
Table
Snapshot Management Status - Indicates whether the SnapshotManagement maintenance action is enabled.
- max
Snapshot NumberAge Hours - The maximum age of a snapshot before it can be expired.
- min
Snapshots NumberTo Keep - The minimum number of snapshots to keep.
- status "enabled" | "disabled"
- Indicates whether the SnapshotManagement maintenance action is enabled.
TableSnapshotManagementStatus, TableSnapshotManagementStatusArgs
- Enabled
enabled- Disabled
disabled
- Table
Snapshot Management Status Enabled enabled- Table
Snapshot Management Status Disabled disabled
- Enabled
enabled- Disabled
disabled
- Enabled
enabled- Disabled
disabled
- ENABLED
enabled- DISABLED
disabled
- "enabled"
enabled- "disabled"
disabled
TableStorageClassConfiguration, TableStorageClassConfigurationArgs
Specifies storage class settings for the table- Storage
Class Pulumi.Aws Native. S3Tables. Table Storage Class Configuration Storage Class - The storage class for the table
- Storage
Class TableStorage Class Configuration Storage Class - The storage class for the table
- storage
Class TableStorage Class Configuration Storage Class - The storage class for the table
- storage
Class TableStorage Class Configuration Storage Class - The storage class for the table
- storage_
class TableStorage Class Configuration Storage Class - The storage class for the table
- storage
Class "STANDARD" | "INTELLIGENT_TIERING" - The storage class for the table
TableStorageClassConfigurationStorageClass, TableStorageClassConfigurationStorageClassArgs
- Standard
STANDARD- Intelligent
Tiering INTELLIGENT_TIERING
- Table
Storage Class Configuration Storage Class Standard STANDARD- Table
Storage Class Configuration Storage Class Intelligent Tiering INTELLIGENT_TIERING
- Standard
STANDARD- Intelligent
Tiering INTELLIGENT_TIERING
- Standard
STANDARD- Intelligent
Tiering INTELLIGENT_TIERING
- STANDARD
STANDARD- INTELLIGENT_TIERING
INTELLIGENT_TIERING
- "STANDARD"
STANDARD- "INTELLIGENT_TIERING"
INTELLIGENT_TIERING
TableWithoutMetadata, TableWithoutMetadataArgs
- Yes
Yes
- Table
Without Metadata Yes Yes
- Yes
Yes
- Yes
Yes
- YES
Yes
- "Yes"
Yes
Tag, TagArgs
A set of tags to apply to the resource.Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
