@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
119 lines (118 loc) • 4.54 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Manages Amazon S3 Tables Table Replication configuration.
*
* ## Example Usage
*
* ### Basic Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.s3tables.TableReplication("example", {
* tableArn: exampleAwsS3tablesTable.arn,
* role: exampleAwsIamRole.arn,
* rule: {
* destinations: [{
* destinationTableBucketArn: target.arn,
* }],
* },
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import S3 Tables Table Replication using the `table_arn`. For example:
*
* ```sh
* $ pulumi import aws:s3tables/tableReplication:TableReplication example 'arn:aws:s3tables:us-west-2:123456789012:table/example-table'
* ```
*/
export declare class TableReplication extends pulumi.CustomResource {
/**
* Get an existing TableReplication 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 state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TableReplicationState, opts?: pulumi.CustomResourceOptions): TableReplication;
/**
* Returns true if the given object is an instance of TableReplication. 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 TableReplication;
/**
* 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.
*/
readonly region: pulumi.Output<string>;
/**
* ARN referencing the IAM role assumed by S3 when replicating tables.
*/
readonly role: pulumi.Output<string>;
/**
* Replication rules. See Rule below for more details.
*/
readonly rule: pulumi.Output<outputs.s3tables.TableReplicationRule | undefined>;
/**
* ARN referencing the Table that owns this replication configuration.
*/
readonly tableArn: pulumi.Output<string>;
readonly versionToken: pulumi.Output<string>;
/**
* Create a TableReplication 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: TableReplicationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering TableReplication resources.
*/
export interface TableReplicationState {
/**
* 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.
*/
region?: pulumi.Input<string>;
/**
* ARN referencing the IAM role assumed by S3 when replicating tables.
*/
role?: pulumi.Input<string>;
/**
* Replication rules. See Rule below for more details.
*/
rule?: pulumi.Input<inputs.s3tables.TableReplicationRule>;
/**
* ARN referencing the Table that owns this replication configuration.
*/
tableArn?: pulumi.Input<string>;
versionToken?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a TableReplication resource.
*/
export interface TableReplicationArgs {
/**
* 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.
*/
region?: pulumi.Input<string>;
/**
* ARN referencing the IAM role assumed by S3 when replicating tables.
*/
role: pulumi.Input<string>;
/**
* Replication rules. See Rule below for more details.
*/
rule?: pulumi.Input<inputs.s3tables.TableReplicationRule>;
/**
* ARN referencing the Table that owns this replication configuration.
*/
tableArn: pulumi.Input<string>;
}