1. Packages
  2. AWS
  3. API Docs
  4. s3tables
  5. TableBucketReplication
AWS v7.14.0 published on Thursday, Dec 11, 2025 by Pulumi
aws logo
AWS v7.14.0 published on Thursday, Dec 11, 2025 by Pulumi

    Manages Amazon S3 Tables Table Bucket Replication configuration.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.s3tables.TableBucketReplication("example", {
        tableBucketArn: source.arn,
        role: exampleAwsIamRole.arn,
        rule: {
            destinations: [{
                destinationTableBucketArn: target.arn,
            }],
        },
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.s3tables.TableBucketReplication("example",
        table_bucket_arn=source["arn"],
        role=example_aws_iam_role["arn"],
        rule={
            "destinations": [{
                "destination_table_bucket_arn": target["arn"],
            }],
        })
    
    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 {
    		_, err := s3tables.NewTableBucketReplication(ctx, "example", &s3tables.TableBucketReplicationArgs{
    			TableBucketArn: pulumi.Any(source.Arn),
    			Role:           pulumi.Any(exampleAwsIamRole.Arn),
    			Rule: &s3tables.TableBucketReplicationRuleArgs{
    				Destinations: s3tables.TableBucketReplicationRuleDestinationArray{
    					&s3tables.TableBucketReplicationRuleDestinationArgs{
    						DestinationTableBucketArn: pulumi.Any(target.Arn),
    					},
    				},
    			},
    		})
    		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.TableBucketReplication("example", new()
        {
            TableBucketArn = source.Arn,
            Role = exampleAwsIamRole.Arn,
            Rule = new Aws.S3Tables.Inputs.TableBucketReplicationRuleArgs
            {
                Destinations = new[]
                {
                    new Aws.S3Tables.Inputs.TableBucketReplicationRuleDestinationArgs
                    {
                        DestinationTableBucketArn = target.Arn,
                    },
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.s3tables.TableBucketReplication;
    import com.pulumi.aws.s3tables.TableBucketReplicationArgs;
    import com.pulumi.aws.s3tables.inputs.TableBucketReplicationRuleArgs;
    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 TableBucketReplication("example", TableBucketReplicationArgs.builder()
                .tableBucketArn(source.arn())
                .role(exampleAwsIamRole.arn())
                .rule(TableBucketReplicationRuleArgs.builder()
                    .destinations(TableBucketReplicationRuleDestinationArgs.builder()
                        .destinationTableBucketArn(target.arn())
                        .build())
                    .build())
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:s3tables:TableBucketReplication
        properties:
          tableBucketArn: ${source.arn}
          role: ${exampleAwsIamRole.arn}
          rule:
            destinations:
              - destinationTableBucketArn: ${target.arn}
    

    Create TableBucketReplication Resource

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

    Constructor syntax

    new TableBucketReplication(name: string, args: TableBucketReplicationArgs, opts?: CustomResourceOptions);
    @overload
    def TableBucketReplication(resource_name: str,
                               args: TableBucketReplicationArgs,
                               opts: Optional[ResourceOptions] = None)
    
    @overload
    def TableBucketReplication(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               role: Optional[str] = None,
                               table_bucket_arn: Optional[str] = None,
                               region: Optional[str] = None,
                               rule: Optional[TableBucketReplicationRuleArgs] = None)
    func NewTableBucketReplication(ctx *Context, name string, args TableBucketReplicationArgs, opts ...ResourceOption) (*TableBucketReplication, error)
    public TableBucketReplication(string name, TableBucketReplicationArgs args, CustomResourceOptions? opts = null)
    public TableBucketReplication(String name, TableBucketReplicationArgs args)
    public TableBucketReplication(String name, TableBucketReplicationArgs args, CustomResourceOptions options)
    
    type: aws:s3tables:TableBucketReplication
    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 TableBucketReplicationArgs
    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 TableBucketReplicationArgs
    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 TableBucketReplicationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TableBucketReplicationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TableBucketReplicationArgs
    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 tableBucketReplicationResource = new Aws.S3Tables.TableBucketReplication("tableBucketReplicationResource", new()
    {
        Role = "string",
        TableBucketArn = "string",
        Region = "string",
        Rule = new Aws.S3Tables.Inputs.TableBucketReplicationRuleArgs
        {
            Destinations = new[]
            {
                new Aws.S3Tables.Inputs.TableBucketReplicationRuleDestinationArgs
                {
                    DestinationTableBucketArn = "string",
                },
            },
        },
    });
    
    example, err := s3tables.NewTableBucketReplication(ctx, "tableBucketReplicationResource", &s3tables.TableBucketReplicationArgs{
    	Role:           pulumi.String("string"),
    	TableBucketArn: pulumi.String("string"),
    	Region:         pulumi.String("string"),
    	Rule: &s3tables.TableBucketReplicationRuleArgs{
    		Destinations: s3tables.TableBucketReplicationRuleDestinationArray{
    			&s3tables.TableBucketReplicationRuleDestinationArgs{
    				DestinationTableBucketArn: pulumi.String("string"),
    			},
    		},
    	},
    })
    
    var tableBucketReplicationResource = new TableBucketReplication("tableBucketReplicationResource", TableBucketReplicationArgs.builder()
        .role("string")
        .tableBucketArn("string")
        .region("string")
        .rule(TableBucketReplicationRuleArgs.builder()
            .destinations(TableBucketReplicationRuleDestinationArgs.builder()
                .destinationTableBucketArn("string")
                .build())
            .build())
        .build());
    
    table_bucket_replication_resource = aws.s3tables.TableBucketReplication("tableBucketReplicationResource",
        role="string",
        table_bucket_arn="string",
        region="string",
        rule={
            "destinations": [{
                "destination_table_bucket_arn": "string",
            }],
        })
    
    const tableBucketReplicationResource = new aws.s3tables.TableBucketReplication("tableBucketReplicationResource", {
        role: "string",
        tableBucketArn: "string",
        region: "string",
        rule: {
            destinations: [{
                destinationTableBucketArn: "string",
            }],
        },
    });
    
    type: aws:s3tables:TableBucketReplication
    properties:
        region: string
        role: string
        rule:
            destinations:
                - destinationTableBucketArn: string
        tableBucketArn: string
    

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

    Role string
    ARN referencing the IAM role assumed by S3 when replicating tables in this bucket.
    TableBucketArn string
    ARN referencing the Table Bucket that owns this replication configuration.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Rule TableBucketReplicationRule
    Replication rules. See Rule below for more details.
    Role string
    ARN referencing the IAM role assumed by S3 when replicating tables in this bucket.
    TableBucketArn string
    ARN referencing the Table Bucket that owns this replication configuration.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Rule TableBucketReplicationRuleArgs
    Replication rules. See Rule below for more details.
    role String
    ARN referencing the IAM role assumed by S3 when replicating tables in this bucket.
    tableBucketArn String
    ARN referencing the Table Bucket that owns this replication configuration.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    rule TableBucketReplicationRule
    Replication rules. See Rule below for more details.
    role string
    ARN referencing the IAM role assumed by S3 when replicating tables in this bucket.
    tableBucketArn string
    ARN referencing the Table Bucket that owns this replication configuration.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    rule TableBucketReplicationRule
    Replication rules. See Rule below for more details.
    role str
    ARN referencing the IAM role assumed by S3 when replicating tables in this bucket.
    table_bucket_arn str
    ARN referencing the Table Bucket that owns this replication configuration.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    rule TableBucketReplicationRuleArgs
    Replication rules. See Rule below for more details.
    role String
    ARN referencing the IAM role assumed by S3 when replicating tables in this bucket.
    tableBucketArn String
    ARN referencing the Table Bucket that owns this replication configuration.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    rule Property Map
    Replication rules. See Rule below for more details.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    VersionToken string
    Id string
    The provider-assigned unique ID for this managed resource.
    VersionToken string
    id String
    The provider-assigned unique ID for this managed resource.
    versionToken String
    id string
    The provider-assigned unique ID for this managed resource.
    versionToken string
    id str
    The provider-assigned unique ID for this managed resource.
    version_token str
    id String
    The provider-assigned unique ID for this managed resource.
    versionToken String

    Look up Existing TableBucketReplication Resource

    Get an existing TableBucketReplication 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?: TableBucketReplicationState, opts?: CustomResourceOptions): TableBucketReplication
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            region: Optional[str] = None,
            role: Optional[str] = None,
            rule: Optional[TableBucketReplicationRuleArgs] = None,
            table_bucket_arn: Optional[str] = None,
            version_token: Optional[str] = None) -> TableBucketReplication
    func GetTableBucketReplication(ctx *Context, name string, id IDInput, state *TableBucketReplicationState, opts ...ResourceOption) (*TableBucketReplication, error)
    public static TableBucketReplication Get(string name, Input<string> id, TableBucketReplicationState? state, CustomResourceOptions? opts = null)
    public static TableBucketReplication get(String name, Output<String> id, TableBucketReplicationState state, CustomResourceOptions options)
    resources:  _:    type: aws:s3tables:TableBucketReplication    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:
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Role string
    ARN referencing the IAM role assumed by S3 when replicating tables in this bucket.
    Rule TableBucketReplicationRule
    Replication rules. See Rule below for more details.
    TableBucketArn string
    ARN referencing the Table Bucket that owns this replication configuration.
    VersionToken string
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Role string
    ARN referencing the IAM role assumed by S3 when replicating tables in this bucket.
    Rule TableBucketReplicationRuleArgs
    Replication rules. See Rule below for more details.
    TableBucketArn string
    ARN referencing the Table Bucket that owns this replication configuration.
    VersionToken string
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    role String
    ARN referencing the IAM role assumed by S3 when replicating tables in this bucket.
    rule TableBucketReplicationRule
    Replication rules. See Rule below for more details.
    tableBucketArn String
    ARN referencing the Table Bucket that owns this replication configuration.
    versionToken String
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    role string
    ARN referencing the IAM role assumed by S3 when replicating tables in this bucket.
    rule TableBucketReplicationRule
    Replication rules. See Rule below for more details.
    tableBucketArn string
    ARN referencing the Table Bucket that owns this replication configuration.
    versionToken string
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    role str
    ARN referencing the IAM role assumed by S3 when replicating tables in this bucket.
    rule TableBucketReplicationRuleArgs
    Replication rules. See Rule below for more details.
    table_bucket_arn str
    ARN referencing the Table Bucket that owns this replication configuration.
    version_token str
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    role String
    ARN referencing the IAM role assumed by S3 when replicating tables in this bucket.
    rule Property Map
    Replication rules. See Rule below for more details.
    tableBucketArn String
    ARN referencing the Table Bucket that owns this replication configuration.
    versionToken String

    Supporting Types

    TableBucketReplicationRule, TableBucketReplicationRuleArgs

    Destinations List<TableBucketReplicationRuleDestination>
    Replication destination. See Destination below for more details.
    Destinations []TableBucketReplicationRuleDestination
    Replication destination. See Destination below for more details.
    destinations List<TableBucketReplicationRuleDestination>
    Replication destination. See Destination below for more details.
    destinations TableBucketReplicationRuleDestination[]
    Replication destination. See Destination below for more details.
    destinations Sequence[TableBucketReplicationRuleDestination]
    Replication destination. See Destination below for more details.
    destinations List<Property Map>
    Replication destination. See Destination below for more details.

    TableBucketReplicationRuleDestination, TableBucketReplicationRuleDestinationArgs

    DestinationTableBucketArn string
    ARN of destination table bucket to replicate source tables to.
    DestinationTableBucketArn string
    ARN of destination table bucket to replicate source tables to.
    destinationTableBucketArn String
    ARN of destination table bucket to replicate source tables to.
    destinationTableBucketArn string
    ARN of destination table bucket to replicate source tables to.
    destination_table_bucket_arn str
    ARN of destination table bucket to replicate source tables to.
    destinationTableBucketArn String
    ARN of destination table bucket to replicate source tables to.

    Import

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

    $ pulumi import aws:s3tables/tableBucketReplication:TableBucketReplication 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 v7.14.0 published on Thursday, Dec 11, 2025 by Pulumi
      Meet Neo: Your AI Platform Teammate