Table class

Resource for managing an Amazon S3 Tables Table.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const exampleTableBucket = new aws.s3tables.TableBucket("example", {name: "example-bucket"});
const exampleNamespace = new aws.s3tables.Namespace("example", {
    namespace: "example_namespace",
    tableBucketArn: exampleTableBucket.arn,
});
const example = new aws.s3tables.Table("example", {
    name: "example_table",
    namespace: exampleNamespace.namespace,
    tableBucketArn: exampleNamespace.tableBucketArn,
    format: "ICEBERG",
});
import pulumi
import pulumi_aws as aws

example_table_bucket = aws.s3tables.TableBucket("example", name="example-bucket")
example_namespace = aws.s3tables.Namespace("example",
    namespace="example_namespace",
    table_bucket_arn=example_table_bucket.arn)
example = aws.s3tables.Table("example",
    name="example_table",
    namespace=example_namespace.namespace,
    table_bucket_arn=example_namespace.table_bucket_arn,
    format="ICEBERG")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var exampleTableBucket = new Aws.S3Tables.TableBucket("example", new()
    {
        Name = "example-bucket",
    });

    var exampleNamespace = new Aws.S3Tables.Namespace("example", new()
    {
        NameSpace = "example_namespace",
        TableBucketArn = exampleTableBucket.Arn,
    });

    var example = new Aws.S3Tables.Table("example", new()
    {
        Name = "example_table",
        Namespace = exampleNamespace.NameSpace,
        TableBucketArn = exampleNamespace.TableBucketArn,
        Format = "ICEBERG",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/s3tables"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleTableBucket, err := s3tables.NewTableBucket(ctx, "example", &s3tables.TableBucketArgs{
			Name: pulumi.String("example-bucket"),
		})
		if err != nil {
			return err
		}
		exampleNamespace, err := s3tables.NewNamespace(ctx, "example", &s3tables.NamespaceArgs{
			Namespace:      pulumi.String("example_namespace"),
			TableBucketArn: exampleTableBucket.Arn,
		})
		if err != nil {
			return err
		}
		_, err = s3tables.NewTable(ctx, "example", &s3tables.TableArgs{
			Name:           pulumi.String("example_table"),
			Namespace:      exampleNamespace.Namespace,
			TableBucketArn: exampleNamespace.TableBucketArn,
			Format:         pulumi.String("ICEBERG"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_s3tables_table" "example" {
  name             = "example_table"
  namespace        = aws_s3tables_namespace.example.namespace
  table_bucket_arn = aws_s3tables_namespace.example.table_bucket_arn
  format           = "ICEBERG"
}
resource "aws_s3tables_namespace" "example" {
  namespace        = "example_namespace"
  table_bucket_arn = aws_s3tables_tablebucket.example.arn
}
resource "aws_s3tables_tablebucket" "example" {
  name = "example-bucket"
}
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());

    }
}
resources:
  example:
    type: aws:s3tables:Table
    properties:
      name: example_table
      namespace: ${exampleNamespace.namespace}
      tableBucketArn: ${exampleNamespace.tableBucketArn}
      format: ICEBERG
  exampleNamespace:
    type: aws:s3tables:Namespace
    name: example
    properties:
      namespace: example_namespace
      tableBucketArn: ${exampleTableBucket.arn}
  exampleTableBucket:
    type: aws:s3tables:TableBucket
    name: example
    properties:
      name: example-bucket

With Metadata Schema

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const exampleTableBucket = new aws.s3tables.TableBucket("example", {name: "example-bucket"});
const exampleNamespace = new aws.s3tables.Namespace("example", {
    namespace: "example_namespace",
    tableBucketArn: exampleTableBucket.arn,
});
const example = new aws.s3tables.Table("example", {
    metadata: {
        iceberg: {
            schema: {
                fields: [
                    {
                        name: "id",
                        type: "long",
                        required: true,
                    },
                    {
                        name: "name",
                        type: "string",
                        required: true,
                    },
                    {
                        name: "created_at",
                        type: "timestamp",
                        required: false,
                    },
                    {
                        name: "price",
                        type: "decimal(10,2)",
                        required: false,
                    },
                ],
            },
        },
    },
    name: "example_table",
    namespace: exampleNamespace.namespace,
    tableBucketArn: exampleNamespace.tableBucketArn,
    format: "ICEBERG",
});
import pulumi
import pulumi_aws as aws

example_table_bucket = aws.s3tables.TableBucket("example", name="example-bucket")
example_namespace = aws.s3tables.Namespace("example",
    namespace="example_namespace",
    table_bucket_arn=example_table_bucket.arn)
example = aws.s3tables.Table("example",
    metadata={
        "iceberg": {
            "schema": {
                "fields": [
                    {
                        "name": "id",
                        "type": "long",
                        "required": True,
                    },
                    {
                        "name": "name",
                        "type": "string",
                        "required": True,
                    },
                    {
                        "name": "created_at",
                        "type": "timestamp",
                        "required": False,
                    },
                    {
                        "name": "price",
                        "type": "decimal(10,2)",
                        "required": False,
                    },
                ],
            },
        },
    },
    name="example_table",
    namespace=example_namespace.namespace,
    table_bucket_arn=example_namespace.table_bucket_arn,
    format="ICEBERG")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var exampleTableBucket = new Aws.S3Tables.TableBucket("example", new()
    {
        Name = "example-bucket",
    });

    var exampleNamespace = new Aws.S3Tables.Namespace("example", new()
    {
        NameSpace = "example_namespace",
        TableBucketArn = exampleTableBucket.Arn,
    });

    var example = new Aws.S3Tables.Table("example", new()
    {
        Metadata = new Aws.S3Tables.Inputs.TableMetadataArgs
        {
            Iceberg = new Aws.S3Tables.Inputs.TableMetadataIcebergArgs
            {
                Schema = new Aws.S3Tables.Inputs.TableMetadataIcebergSchemaArgs
                {
                    Fields = new[]
                    {
                        new Aws.S3Tables.Inputs.TableMetadataIcebergSchemaFieldArgs
                        {
                            Name = "id",
                            Type = "long",
                            Required = true,
                        },
                        new Aws.S3Tables.Inputs.TableMetadataIcebergSchemaFieldArgs
                        {
                            Name = "name",
                            Type = "string",
                            Required = true,
                        },
                        new Aws.S3Tables.Inputs.TableMetadataIcebergSchemaFieldArgs
                        {
                            Name = "created_at",
                            Type = "timestamp",
                            Required = false,
                        },
                        new Aws.S3Tables.Inputs.TableMetadataIcebergSchemaFieldArgs
                        {
                            Name = "price",
                            Type = "decimal(10,2)",
                            Required = false,
                        },
                    },
                },
            },
        },
        Name = "example_table",
        Namespace = exampleNamespace.NameSpace,
        TableBucketArn = exampleNamespace.TableBucketArn,
        Format = "ICEBERG",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/s3tables"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleTableBucket, err := s3tables.NewTableBucket(ctx, "example", &s3tables.TableBucketArgs{
			Name: pulumi.String("example-bucket"),
		})
		if err != nil {
			return err
		}
		exampleNamespace, err := s3tables.NewNamespace(ctx, "example", &s3tables.NamespaceArgs{
			Namespace:      pulumi.String("example_namespace"),
			TableBucketArn: exampleTableBucket.Arn,
		})
		if err != nil {
			return err
		}
		_, err = s3tables.NewTable(ctx, "example", &s3tables.TableArgs{
			Metadata: &s3tables.TableMetadataArgs{
				Iceberg: &s3tables.TableMetadataIcebergArgs{
					Schema: &s3tables.TableMetadataIcebergSchemaArgs{
						Fields: s3tables.TableMetadataIcebergSchemaFieldArray{
							&s3tables.TableMetadataIcebergSchemaFieldArgs{
								Name:     pulumi.String("id"),
								Type:     pulumi.String("long"),
								Required: pulumi.Bool(true),
							},
							&s3tables.TableMetadataIcebergSchemaFieldArgs{
								Name:     pulumi.String("name"),
								Type:     pulumi.String("string"),
								Required: pulumi.Bool(true),
							},
							&s3tables.TableMetadataIcebergSchemaFieldArgs{
								Name:     pulumi.String("created_at"),
								Type:     pulumi.String("timestamp"),
								Required: pulumi.Bool(false),
							},
							&s3tables.TableMetadataIcebergSchemaFieldArgs{
								Name:     pulumi.String("price"),
								Type:     pulumi.String("decimal(10,2)"),
								Required: pulumi.Bool(false),
							},
						},
					},
				},
			},
			Name:           pulumi.String("example_table"),
			Namespace:      exampleNamespace.Namespace,
			TableBucketArn: exampleNamespace.TableBucketArn,
			Format:         pulumi.String("ICEBERG"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_s3tables_table" "example" {
  metadata = {
    iceberg = {
      schema = {
        fields = [{
          "name"     = "id"
          "type"     = "long"
          "required" = true
          }, {
          "name"     = "name"
          "type"     = "string"
          "required" = true
          }, {
          "name"     = "created_at"
          "type"     = "timestamp"
          "required" = false
          }, {
          "name"     = "price"
          "type"     = "decimal(10,2)"
          "required" = false
        }]
      }
    }
  }
  name             = "example_table"
  namespace        = aws_s3tables_namespace.example.namespace
  table_bucket_arn = aws_s3tables_namespace.example.table_bucket_arn
  format           = "ICEBERG"
}
resource "aws_s3tables_namespace" "example" {
  namespace        = "example_namespace"
  table_bucket_arn = aws_s3tables_tablebucket.example.arn
}
resource "aws_s3tables_tablebucket" "example" {
  name = "example-bucket"
}
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());

    }
}
resources:
  example:
    type: aws:s3tables:Table
    properties:
      metadata:
        iceberg:
          schema:
            fields:
              - name: id
                type: long
                required: true
              - name: name
                type: string
                required: true
              - name: created_at
                type: timestamp
                required: false
              - name: price
                type: decimal(10,2)
                required: false
      name: example_table
      namespace: ${exampleNamespace.namespace}
      tableBucketArn: ${exampleNamespace.tableBucketArn}
      format: ICEBERG
  exampleNamespace:
    type: aws:s3tables:Namespace
    name: example
    properties:
      namespace: example_namespace
      tableBucketArn: ${exampleTableBucket.arn}
  exampleTableBucket:
    type: aws:s3tables:TableBucket
    name: example
    properties:
      name: example-bucket

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:

$ pulumi import aws:s3tables/table:Table example 'arn:aws:s3tables:us-west-2:123456789012:bucket/example-bucket;example-namespace;example-table'

Constructors

Table(String name, {TableArgs? args, CustomResourceOptions? options})
Creates a new Table. name The Pulumi resource name. args Arguments used to configure this Table. The set of arguments for Table. options Resource options controlling this resource's behavior.
Table.reference(String urn)
Creates a typed reference to an existing Table resource.

Properties

arn ↔ Output<String>
ARN of the table.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
createdAt ↔ Output<String>
Date and time when the namespace was created.
latefinal
createdBy ↔ Output<String>
Account ID of the account that created the namespace.
latefinal
encryptionConfiguration ↔ Output<TableEncryptionConfiguration>
Single table bucket encryption configuration object. See encryptionConfiguration below.
latefinal
format ↔ Output<String>
Format of the table. Must be ICEBERG.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
maintenanceConfiguration ↔ Output<TableMaintenanceConfiguration>
Single table bucket maintenance configuration object. See maintenanceConfiguration below.
latefinal
metadata ↔ Output<TableMetadata?>
Details about the table metadata. This configuration specifies the metadata format and schema for the table. Currently only supports Iceberg format. See metadata below.
latefinal
metadataLocation ↔ Output<String>
Location of table metadata.
latefinal
modifiedAt ↔ Output<String>
Date and time when the namespace was last modified.
latefinal
modifiedBy ↔ Output<String>
Account ID of the account that last modified the namespace.
latefinal
name ↔ Output<String>
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.
latefinal
namespace ↔ Output<String>
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.
latefinal
ownerAccountId ↔ Output<String>
Account ID of the account that owns the namespace.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tableBucketArn ↔ Output<String>
ARN referencing the Table Bucket that contains this Namespace.
latefinal
tags ↔ Output<Map<String, String>?>
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.
latefinal
tagsAll ↔ Output<Map<String, String>>
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
type ↔ Output<String>
Type of the table. One of customer or aws.
latefinal
urn ↔ Output<String>
latefinalinherited
versionToken ↔ Output<String>
Identifier for the current version of table data.
latefinal
warehouseLocation ↔ Output<String>
S3 URI pointing to the S3 Bucket that contains the table data.
latefinal

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {TableState? state, CustomResourceOptions? options}) → Table
Gets an existing Table resource's state with the given name and id.