Package com.pulumi.aws.s3tables

Class Table

  • public class Table
extends com.pulumi.resources.CustomResource
    Resource for managing an Amazon S3 Tables Table. ## Example Usage ### Basic Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.s3tables.TableBucket;
 import com.pulumi.aws.s3tables.TableBucketArgs;
 import com.pulumi.aws.s3tables.Namespace;
 import com.pulumi.aws.s3tables.NamespaceArgs;
 import com.pulumi.aws.s3tables.Table;
 import com.pulumi.aws.s3tables.TableArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var exampleTableBucket = new TableBucket("exampleTableBucket", TableBucketArgs.builder()
             .name("example-bucket")
             .build());
 
         var exampleNamespace = new Namespace("exampleNamespace", NamespaceArgs.builder()
             .namespace("example_namespace")
             .tableBucketArn(exampleTableBucket.arn())
             .build());
 
         var example = new Table("example", TableArgs.builder()
             .name("example_table")
             .namespace(exampleNamespace.namespace())
             .tableBucketArn(exampleNamespace.tableBucketArn())
             .format("ICEBERG")
             .build());
 
     }
 }
    ### With Metadata Schema 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.s3tables.TableBucket;
 import com.pulumi.aws.s3tables.TableBucketArgs;
 import com.pulumi.aws.s3tables.Namespace;
 import com.pulumi.aws.s3tables.NamespaceArgs;
 import com.pulumi.aws.s3tables.Table;
 import com.pulumi.aws.s3tables.TableArgs;
 import com.pulumi.aws.s3tables.inputs.TableMetadataArgs;
 import com.pulumi.aws.s3tables.inputs.TableMetadataIcebergArgs;
 import com.pulumi.aws.s3tables.inputs.TableMetadataIcebergSchemaArgs;
 import com.pulumi.aws.s3tables.inputs.TableMetadataIcebergSchemaFieldArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var exampleTableBucket = new TableBucket("exampleTableBucket", TableBucketArgs.builder()
             .name("example-bucket")
             .build());
 
         var exampleNamespace = new Namespace("exampleNamespace", NamespaceArgs.builder()
             .namespace("example_namespace")
             .tableBucketArn(exampleTableBucket.arn())
             .build());
 
         var example = new Table("example", TableArgs.builder()
             .metadata(TableMetadataArgs.builder()
                 .iceberg(TableMetadataIcebergArgs.builder()
                     .schema(TableMetadataIcebergSchemaArgs.builder()
                         .fields(                        
                             TableMetadataIcebergSchemaFieldArgs.builder()
                                 .name("id")
                                 .type("long")
                                 .required(true)
                                 .build(),
                             TableMetadataIcebergSchemaFieldArgs.builder()
                                 .name("name")
                                 .type("string")
                                 .required(true)
                                 .build(),
                             TableMetadataIcebergSchemaFieldArgs.builder()
                                 .name("created_at")
                                 .type("timestamp")
                                 .required(false)
                                 .build(),
                             TableMetadataIcebergSchemaFieldArgs.builder()
                                 .name("price")
                                 .type("decimal(10,2)")
                                 .required(false)
                                 .build())
                         .build())
                     .build())
                 .build())
             .name("example_table")
             .namespace(exampleNamespace.namespace())
             .tableBucketArn(exampleNamespace.tableBucketArn())
             .format("ICEBERG")
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import S3 Tables Table using the `tableBucketArn`, the value of `namespace`, and the value of `name`, separated by a semicolon (`;`). For example: ```sh $ pulumi import aws:s3tables/table:Table example 'arn:aws:s3tables:us-west-2:123456789012:bucket/example-bucket;example-namespace;example-table' ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Constructor Summary

      Constructors 
      Constructor Description
      Table​(java.lang.String name)  
      Table​(java.lang.String name, TableArgs args)  
      Table​(java.lang.String name, TableArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.lang.String> createdAt()  
      com.pulumi.core.Output<java.lang.String> createdBy()  
      com.pulumi.core.Output<TableEncryptionConfiguration> encryptionConfiguration()  
      com.pulumi.core.Output<java.lang.String> format()  
      static Table get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, TableState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<TableMaintenanceConfiguration> maintenanceConfiguration()  
      com.pulumi.core.Output<java.util.Optional<TableMetadata>> metadata()  
      com.pulumi.core.Output<java.lang.String> metadataLocation()  
      com.pulumi.core.Output<java.lang.String> modifiedAt()  
      com.pulumi.core.Output<java.lang.String> modifiedBy()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> namespace()  
      com.pulumi.core.Output<java.lang.String> ownerAccountId()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> tableBucketArn()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.lang.String> type()  
      com.pulumi.core.Output<java.lang.String> versionToken()  
      com.pulumi.core.Output<java.lang.String> warehouseLocation()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Table

        public Table​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • Table

        public Table​(java.lang.String name,
             TableArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • Table

        public Table​(java.lang.String name,
             TableArgs args,
             @Nullable
             com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the table.

      • createdAt

        public com.pulumi.core.Output<java.lang.String> createdAt()
        Returns:
        Date and time when the namespace was created.

      • createdBy

        public com.pulumi.core.Output<java.lang.String> createdBy()
        Returns:
        Account ID of the account that created the namespace.

      • encryptionConfiguration

        public com.pulumi.core.Output<TableEncryptionConfiguration> encryptionConfiguration()
        Returns:
        Single table bucket encryption configuration object. See `encryptionConfiguration` below.

      • format

        public com.pulumi.core.Output<java.lang.String> format()
        Returns:
        Format of the table. Must be `ICEBERG`.

      • maintenanceConfiguration

        public com.pulumi.core.Output<TableMaintenanceConfiguration> maintenanceConfiguration()
        Returns:
        Single table bucket maintenance configuration object. See `maintenanceConfiguration` below.

      • metadata

        public com.pulumi.core.Output<java.util.Optional<TableMetadata>> metadata()
        Returns:
        Details about the table metadata. This configuration specifies the metadata format and schema for the table. Currently only supports Iceberg format. See `metadata` below.

      • metadataLocation

        public com.pulumi.core.Output<java.lang.String> metadataLocation()
        Returns:
        Location of table metadata.

      • modifiedAt

        public com.pulumi.core.Output<java.lang.String> modifiedAt()
        Returns:
        Date and time when the namespace was last modified.

      • modifiedBy

        public com.pulumi.core.Output<java.lang.String> modifiedBy()
        Returns:
        Account ID of the account that last modified the namespace.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name of the table. Must be between 1 and 255 characters in length. Can consist of lowercase letters, numbers, and underscores, and must begin and end with a lowercase letter or number. A full list of table naming rules can be found in the [S3 Tables documentation](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-buckets-naming.html#naming-rules-table).

      • namespace

        public com.pulumi.core.Output<java.lang.String> namespace()
        Returns:
        Name of the namespace for this table. Must be between 1 and 255 characters in length. Can consist of lowercase letters, numbers, and underscores, and must begin and end with a lowercase letter or number.

      • ownerAccountId

        public com.pulumi.core.Output<java.lang.String> ownerAccountId()
        Returns:
        Account ID of the account that owns the namespace.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • tableBucketArn

        public com.pulumi.core.Output<java.lang.String> tableBucketArn()
        Returns:
        ARN referencing the Table Bucket that contains this Namespace. The following arguments are optional:

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • type

        public com.pulumi.core.Output<java.lang.String> type()
        Returns:
        Type of the table. One of `customer` or `aws`.

      • versionToken

        public com.pulumi.core.Output<java.lang.String> versionToken()
        Returns:
        Identifier for the current version of table data.

      • warehouseLocation

        public com.pulumi.core.Output<java.lang.String> warehouseLocation()
        Returns:
        S3 URI pointing to the S3 Bucket that contains the table data.

      • get

        public static Table get​(java.lang.String name,
                        com.pulumi.core.Output<java.lang.String> id,
                        @Nullable
                        TableState state,
                        @Nullable
                        com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.