@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
129 lines (128 loc) • 5.33 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Resource Type definition for AWS::S3Tables::Table
*/
export declare class Table extends pulumi.CustomResource {
/**
* Get an existing Table resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Table;
/**
* Returns true if the given object is an instance of Table. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Table;
/**
* Contains details about the compaction settings for an Iceberg table.
*/
readonly compaction: pulumi.Output<outputs.s3tables.TableCompaction | undefined>;
/**
* Contains details about the metadata for an Iceberg table.
*/
readonly icebergMetadata: pulumi.Output<outputs.s3tables.TableIcebergMetadata | undefined>;
/**
* The name of the namespace.
*/
readonly namespace: pulumi.Output<string>;
/**
* The format of the table.
*/
readonly openTableFormat: pulumi.Output<enums.s3tables.TableOpenTableFormat>;
/**
* Contains details about the Iceberg snapshot management settings for the table.
*/
readonly snapshotManagement: pulumi.Output<outputs.s3tables.TableSnapshotManagement | undefined>;
/**
* 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.
*/
readonly storageClassConfiguration: pulumi.Output<outputs.s3tables.TableStorageClassConfiguration | undefined>;
/**
* The Amazon Resource Name (ARN) of the table.
*/
readonly tableArn: pulumi.Output<string>;
/**
* The Amazon Resource Name (ARN) of the table bucket to create the table in.
*/
readonly tableBucketArn: pulumi.Output<string>;
/**
* The name for the table.
*/
readonly tableName: pulumi.Output<string>;
/**
* User tags (key-value pairs) to associate with the table.
*/
readonly tags: pulumi.Output<outputs.Tag[] | undefined>;
/**
* The version token of the table.
*/
readonly versionToken: pulumi.Output<string>;
/**
* The warehouse location of the table.
*/
readonly warehouseLocation: pulumi.Output<string>;
/**
* 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 is `Yes` .
*/
readonly withoutMetadata: pulumi.Output<enums.s3tables.TableWithoutMetadata | undefined>;
/**
* Create a Table resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: TableArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Table resource.
*/
export interface TableArgs {
/**
* Contains details about the compaction settings for an Iceberg table.
*/
compaction?: pulumi.Input<inputs.s3tables.TableCompactionArgs>;
/**
* Contains details about the metadata for an Iceberg table.
*/
icebergMetadata?: pulumi.Input<inputs.s3tables.TableIcebergMetadataArgs>;
/**
* The name of the namespace.
*/
namespace: pulumi.Input<string>;
/**
* The format of the table.
*/
openTableFormat: pulumi.Input<enums.s3tables.TableOpenTableFormat>;
/**
* Contains details about the Iceberg snapshot management settings for the table.
*/
snapshotManagement?: pulumi.Input<inputs.s3tables.TableSnapshotManagementArgs>;
/**
* 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.
*/
storageClassConfiguration?: pulumi.Input<inputs.s3tables.TableStorageClassConfigurationArgs>;
/**
* The Amazon Resource Name (ARN) of the table bucket to create the table in.
*/
tableBucketArn: pulumi.Input<string>;
/**
* The name for the table.
*/
tableName?: pulumi.Input<string>;
/**
* User tags (key-value pairs) to associate with the table.
*/
tags?: pulumi.Input<pulumi.Input<inputs.TagArgs>[]>;
/**
* 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 is `Yes` .
*/
withoutMetadata?: pulumi.Input<enums.s3tables.TableWithoutMetadata>;
}