Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. s3tables
  5. TableBucket
AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
pulumi/pulumi-aws

aws.s3tables.TableBucket

Explore with Pulumi AI

aws logo
AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
pulumi/pulumi-aws

    Resource for managing an Amazon S3 Tables Table Bucket.

    Example Usage

    Basic Usage

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

const example = new aws.s3tables.TableBucket("example", {name: "example-bucket"});

    import pulumi
import pulumi_aws as aws

example = aws.s3tables.TableBucket("example", name="example-bucket")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := s3tables.NewTableBucket(ctx, "example", &s3tables.TableBucketArgs{
			Name: pulumi.String("example-bucket"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.S3Tables.TableBucket("example", new()
    {
        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 java.util.List;
import java.util.ArrayList;
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 example = new TableBucket("example", TableBucketArgs.builder()
            .name("example-bucket")
            .build());

    }
}

    resources:
  example:
    type: aws:s3tables:TableBucket
    properties:
      name: example-bucket

    Create TableBucket Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new TableBucket(name: string, args?: TableBucketArgs, opts?: CustomResourceOptions);
    @overload
def TableBucket(resource_name: str,
                args: Optional[TableBucketArgs] = None,
                opts: Optional[ResourceOptions] = None)

@overload
def TableBucket(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                maintenance_configuration: Optional[TableBucketMaintenanceConfigurationArgs] = None,
                name: Optional[str] = None)
    func NewTableBucket(ctx *Context, name string, args *TableBucketArgs, opts ...ResourceOption) (*TableBucket, error)
    public TableBucket(string name, TableBucketArgs? args = null, CustomResourceOptions? opts = null)
    public TableBucket(String name, TableBucketArgs args)
public TableBucket(String name, TableBucketArgs args, CustomResourceOptions options)

    type: aws:s3tables:TableBucket
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 TableBucketArgs
    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 TableBucketArgs
    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 TableBucketArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TableBucketArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TableBucketArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var tableBucketResource = new Aws.S3Tables.TableBucket("tableBucketResource", new()
{
    MaintenanceConfiguration = new Aws.S3Tables.Inputs.TableBucketMaintenanceConfigurationArgs
    {
        IcebergUnreferencedFileRemoval = new Aws.S3Tables.Inputs.TableBucketMaintenanceConfigurationIcebergUnreferencedFileRemovalArgs
        {
            Settings = new Aws.S3Tables.Inputs.TableBucketMaintenanceConfigurationIcebergUnreferencedFileRemovalSettingsArgs
            {
                NonCurrentDays = 0,
                UnreferencedDays = 0,
            },
            Status = "string",
        },
    },
    Name = "string",
});

    example, err := s3tables.NewTableBucket(ctx, "tableBucketResource", &s3tables.TableBucketArgs{
	MaintenanceConfiguration: &s3tables.TableBucketMaintenanceConfigurationArgs{
		IcebergUnreferencedFileRemoval: &s3tables.TableBucketMaintenanceConfigurationIcebergUnreferencedFileRemovalArgs{
			Settings: &s3tables.TableBucketMaintenanceConfigurationIcebergUnreferencedFileRemovalSettingsArgs{
				NonCurrentDays:   pulumi.Int(0),
				UnreferencedDays: pulumi.Int(0),
			},
			Status: pulumi.String("string"),
		},
	},
	Name: pulumi.String("string"),
})

    var tableBucketResource = new TableBucket("tableBucketResource", TableBucketArgs.builder()
    .maintenanceConfiguration(TableBucketMaintenanceConfigurationArgs.builder()
        .icebergUnreferencedFileRemoval(TableBucketMaintenanceConfigurationIcebergUnreferencedFileRemovalArgs.builder()
            .settings(TableBucketMaintenanceConfigurationIcebergUnreferencedFileRemovalSettingsArgs.builder()
                .nonCurrentDays(0)
                .unreferencedDays(0)
                .build())
            .status("string")
            .build())
        .build())
    .name("string")
    .build());

    table_bucket_resource = aws.s3tables.TableBucket("tableBucketResource",
    maintenance_configuration={
        "iceberg_unreferenced_file_removal": {
            "settings": {
                "non_current_days": 0,
                "unreferenced_days": 0,
            },
            "status": "string",
        },
    },
    name="string")

    const tableBucketResource = new aws.s3tables.TableBucket("tableBucketResource", {
    maintenanceConfiguration: {
        icebergUnreferencedFileRemoval: {
            settings: {
                nonCurrentDays: 0,
                unreferencedDays: 0,
            },
            status: "string",
        },
    },
    name: "string",
});

    type: aws:s3tables:TableBucket
properties:
    maintenanceConfiguration:
        icebergUnreferencedFileRemoval:
            settings:
                nonCurrentDays: 0
                unreferencedDays: 0
            status: string
    name: string

    TableBucket 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 TableBucket resource accepts the following input properties:

    MaintenanceConfiguration TableBucketMaintenanceConfiguration
    A single table bucket maintenance configuration block. See maintenance_configuration below.
    Name string

    Name of the table bucket. Must be between 3 and 63 characters in length. Can consist of lowercase letters, numbers, and hyphens, and must begin and end with a lowercase letter or number. A full list of bucket naming rules can be found in the S3 Tables documentation.

    The following argument is optional:

    MaintenanceConfiguration TableBucketMaintenanceConfigurationArgs
    A single table bucket maintenance configuration block. See maintenance_configuration below.
    Name string

    Name of the table bucket. Must be between 3 and 63 characters in length. Can consist of lowercase letters, numbers, and hyphens, and must begin and end with a lowercase letter or number. A full list of bucket naming rules can be found in the S3 Tables documentation.

    The following argument is optional:

    maintenanceConfiguration TableBucketMaintenanceConfiguration
    A single table bucket maintenance configuration block. See maintenance_configuration below.
    name String

    Name of the table bucket. Must be between 3 and 63 characters in length. Can consist of lowercase letters, numbers, and hyphens, and must begin and end with a lowercase letter or number. A full list of bucket naming rules can be found in the S3 Tables documentation.

    The following argument is optional:

    maintenanceConfiguration TableBucketMaintenanceConfiguration
    A single table bucket maintenance configuration block. See maintenance_configuration below.
    name string

    Name of the table bucket. Must be between 3 and 63 characters in length. Can consist of lowercase letters, numbers, and hyphens, and must begin and end with a lowercase letter or number. A full list of bucket naming rules can be found in the S3 Tables documentation.

    The following argument is optional:

    maintenance_configuration TableBucketMaintenanceConfigurationArgs
    A single table bucket maintenance configuration block. See maintenance_configuration below.
    name str

    Name of the table bucket. Must be between 3 and 63 characters in length. Can consist of lowercase letters, numbers, and hyphens, and must begin and end with a lowercase letter or number. A full list of bucket naming rules can be found in the S3 Tables documentation.

    The following argument is optional:

    maintenanceConfiguration Property Map
    A single table bucket maintenance configuration block. See maintenance_configuration below.
    name String

    Name of the table bucket. Must be between 3 and 63 characters in length. Can consist of lowercase letters, numbers, and hyphens, and must begin and end with a lowercase letter or number. A full list of bucket naming rules can be found in the S3 Tables documentation.

    The following argument is optional:

    Outputs

    All input properties are implicitly available as output properties. Additionally, the TableBucket resource produces the following output properties:

    Arn string
    ARN of the table bucket.
    CreatedAt string
    Date and time when the bucket was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    OwnerAccountId string
    Account ID of the account that owns the table bucket.
    Arn string
    ARN of the table bucket.
    CreatedAt string
    Date and time when the bucket was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    OwnerAccountId string
    Account ID of the account that owns the table bucket.
    arn String
    ARN of the table bucket.
    createdAt String
    Date and time when the bucket was created.
    id String
    The provider-assigned unique ID for this managed resource.
    ownerAccountId String
    Account ID of the account that owns the table bucket.
    arn string
    ARN of the table bucket.
    createdAt string
    Date and time when the bucket was created.
    id string
    The provider-assigned unique ID for this managed resource.
    ownerAccountId string
    Account ID of the account that owns the table bucket.
    arn str
    ARN of the table bucket.
    created_at str
    Date and time when the bucket was created.
    id str
    The provider-assigned unique ID for this managed resource.
    owner_account_id str
    Account ID of the account that owns the table bucket.
    arn String
    ARN of the table bucket.
    createdAt String
    Date and time when the bucket was created.
    id String
    The provider-assigned unique ID for this managed resource.
    ownerAccountId String
    Account ID of the account that owns the table bucket.

    Look up Existing TableBucket Resource

    Get an existing TableBucket resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: TableBucketState, opts?: CustomResourceOptions): TableBucket
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        created_at: Optional[str] = None,
        maintenance_configuration: Optional[TableBucketMaintenanceConfigurationArgs] = None,
        name: Optional[str] = None,
        owner_account_id: Optional[str] = None) -> TableBucket
    func GetTableBucket(ctx *Context, name string, id IDInput, state *TableBucketState, opts ...ResourceOption) (*TableBucket, error)
    public static TableBucket Get(string name, Input<string> id, TableBucketState? state, CustomResourceOptions? opts = null)
    public static TableBucket get(String name, Output<String> id, TableBucketState state, CustomResourceOptions options)
    resources:  _:    type: aws:s3tables:TableBucket    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    ARN of the table bucket.
    CreatedAt string
    Date and time when the bucket was created.
    MaintenanceConfiguration TableBucketMaintenanceConfiguration
    A single table bucket maintenance configuration block. See maintenance_configuration below.
    Name string

    Name of the table bucket. Must be between 3 and 63 characters in length. Can consist of lowercase letters, numbers, and hyphens, and must begin and end with a lowercase letter or number. A full list of bucket naming rules can be found in the S3 Tables documentation.

    The following argument is optional:

    OwnerAccountId string
    Account ID of the account that owns the table bucket.
    Arn string
    ARN of the table bucket.
    CreatedAt string
    Date and time when the bucket was created.
    MaintenanceConfiguration TableBucketMaintenanceConfigurationArgs
    A single table bucket maintenance configuration block. See maintenance_configuration below.
    Name string

    Name of the table bucket. Must be between 3 and 63 characters in length. Can consist of lowercase letters, numbers, and hyphens, and must begin and end with a lowercase letter or number. A full list of bucket naming rules can be found in the S3 Tables documentation.

    The following argument is optional:

    OwnerAccountId string
    Account ID of the account that owns the table bucket.
    arn String
    ARN of the table bucket.
    createdAt String
    Date and time when the bucket was created.
    maintenanceConfiguration TableBucketMaintenanceConfiguration
    A single table bucket maintenance configuration block. See maintenance_configuration below.
    name String

    Name of the table bucket. Must be between 3 and 63 characters in length. Can consist of lowercase letters, numbers, and hyphens, and must begin and end with a lowercase letter or number. A full list of bucket naming rules can be found in the S3 Tables documentation.

    The following argument is optional:

    ownerAccountId String
    Account ID of the account that owns the table bucket.
    arn string
    ARN of the table bucket.
    createdAt string
    Date and time when the bucket was created.
    maintenanceConfiguration TableBucketMaintenanceConfiguration
    A single table bucket maintenance configuration block. See maintenance_configuration below.
    name string

    Name of the table bucket. Must be between 3 and 63 characters in length. Can consist of lowercase letters, numbers, and hyphens, and must begin and end with a lowercase letter or number. A full list of bucket naming rules can be found in the S3 Tables documentation.

    The following argument is optional:

    ownerAccountId string
    Account ID of the account that owns the table bucket.
    arn str
    ARN of the table bucket.
    created_at str
    Date and time when the bucket was created.
    maintenance_configuration TableBucketMaintenanceConfigurationArgs
    A single table bucket maintenance configuration block. See maintenance_configuration below.
    name str

    Name of the table bucket. Must be between 3 and 63 characters in length. Can consist of lowercase letters, numbers, and hyphens, and must begin and end with a lowercase letter or number. A full list of bucket naming rules can be found in the S3 Tables documentation.

    The following argument is optional:

    owner_account_id str
    Account ID of the account that owns the table bucket.
    arn String
    ARN of the table bucket.
    createdAt String
    Date and time when the bucket was created.
    maintenanceConfiguration Property Map
    A single table bucket maintenance configuration block. See maintenance_configuration below.
    name String

    Name of the table bucket. Must be between 3 and 63 characters in length. Can consist of lowercase letters, numbers, and hyphens, and must begin and end with a lowercase letter or number. A full list of bucket naming rules can be found in the S3 Tables documentation.

    The following argument is optional:

    ownerAccountId String
    Account ID of the account that owns the table bucket.

    Supporting Types

    TableBucketMaintenanceConfiguration, TableBucketMaintenanceConfigurationArgs

    IcebergUnreferencedFileRemoval TableBucketMaintenanceConfigurationIcebergUnreferencedFileRemoval
    A single Iceberg unreferenced file removal settings block. See iceberg_unreferenced_file_removal below.
    IcebergUnreferencedFileRemoval TableBucketMaintenanceConfigurationIcebergUnreferencedFileRemoval
    A single Iceberg unreferenced file removal settings block. See iceberg_unreferenced_file_removal below.
    icebergUnreferencedFileRemoval TableBucketMaintenanceConfigurationIcebergUnreferencedFileRemoval
    A single Iceberg unreferenced file removal settings block. See iceberg_unreferenced_file_removal below.
    icebergUnreferencedFileRemoval TableBucketMaintenanceConfigurationIcebergUnreferencedFileRemoval
    A single Iceberg unreferenced file removal settings block. See iceberg_unreferenced_file_removal below.
    iceberg_unreferenced_file_removal TableBucketMaintenanceConfigurationIcebergUnreferencedFileRemoval
    A single Iceberg unreferenced file removal settings block. See iceberg_unreferenced_file_removal below.
    icebergUnreferencedFileRemoval Property Map
    A single Iceberg unreferenced file removal settings block. See iceberg_unreferenced_file_removal below.

    TableBucketMaintenanceConfigurationIcebergUnreferencedFileRemoval, TableBucketMaintenanceConfigurationIcebergUnreferencedFileRemovalArgs

    Settings TableBucketMaintenanceConfigurationIcebergUnreferencedFileRemovalSettings
    Settings for unreferenced file removal. See iceberg_unreferenced_file_removal.settings below.
    Status string
    Whether the configuration is enabled. Valid values are enabled and disabled.
    Settings TableBucketMaintenanceConfigurationIcebergUnreferencedFileRemovalSettings
    Settings for unreferenced file removal. See iceberg_unreferenced_file_removal.settings below.
    Status string
    Whether the configuration is enabled. Valid values are enabled and disabled.
    settings TableBucketMaintenanceConfigurationIcebergUnreferencedFileRemovalSettings
    Settings for unreferenced file removal. See iceberg_unreferenced_file_removal.settings below.
    status String
    Whether the configuration is enabled. Valid values are enabled and disabled.
    settings TableBucketMaintenanceConfigurationIcebergUnreferencedFileRemovalSettings
    Settings for unreferenced file removal. See iceberg_unreferenced_file_removal.settings below.
    status string
    Whether the configuration is enabled. Valid values are enabled and disabled.
    settings TableBucketMaintenanceConfigurationIcebergUnreferencedFileRemovalSettings
    Settings for unreferenced file removal. See iceberg_unreferenced_file_removal.settings below.
    status str
    Whether the configuration is enabled. Valid values are enabled and disabled.
    settings Property Map
    Settings for unreferenced file removal. See iceberg_unreferenced_file_removal.settings below.
    status String
    Whether the configuration is enabled. Valid values are enabled and disabled.

    TableBucketMaintenanceConfigurationIcebergUnreferencedFileRemovalSettings, TableBucketMaintenanceConfigurationIcebergUnreferencedFileRemovalSettingsArgs

    NonCurrentDays int
    Data objects marked for deletion are deleted after this many days. Must be at least 1.
    UnreferencedDays int
    Unreferenced data objects are marked for deletion after this many days. Must be at least 1.
    NonCurrentDays int
    Data objects marked for deletion are deleted after this many days. Must be at least 1.
    UnreferencedDays int
    Unreferenced data objects are marked for deletion after this many days. Must be at least 1.
    nonCurrentDays Integer
    Data objects marked for deletion are deleted after this many days. Must be at least 1.
    unreferencedDays Integer
    Unreferenced data objects are marked for deletion after this many days. Must be at least 1.
    nonCurrentDays number
    Data objects marked for deletion are deleted after this many days. Must be at least 1.
    unreferencedDays number
    Unreferenced data objects are marked for deletion after this many days. Must be at least 1.
    non_current_days int
    Data objects marked for deletion are deleted after this many days. Must be at least 1.
    unreferenced_days int
    Unreferenced data objects are marked for deletion after this many days. Must be at least 1.
    nonCurrentDays Number
    Data objects marked for deletion are deleted after this many days. Must be at least 1.
    unreferencedDays Number
    Unreferenced data objects are marked for deletion after this many days. Must be at least 1.

    Import

    Using pulumi import, import S3 Tables Table Bucket using the arn. For example:

    $ pulumi import aws:s3tables/tableBucket:TableBucket example arn:aws:s3tables:us-west-2:123456789012:bucket/example-bucket

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
    pulumi/pulumi-aws