@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
154 lines (153 loc) • 6.49 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Resource for managing an Amazon S3 Tables Table Bucket.
*
* ## Example Usage
*
* ### Basic Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.s3tables.TableBucket("example", {name: "example-bucket"});
* ```
*
* ## Import
*
* Using `pulumi import`, import S3 Tables Table Bucket using the `arn`. For example:
*
* ```sh
* $ pulumi import aws:s3tables/tableBucket:TableBucket example arn:aws:s3tables:us-west-2:123456789012:bucket/example-bucket
* ```
*/
export declare class TableBucket extends pulumi.CustomResource {
/**
* Get an existing TableBucket 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?: TableBucketState, opts?: pulumi.CustomResourceOptions): TableBucket;
/**
* Returns true if the given object is an instance of TableBucket. 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 TableBucket;
/**
* ARN of the table bucket.
*/
readonly arn: pulumi.Output<string>;
/**
* Date and time when the bucket was created.
*/
readonly createdAt: pulumi.Output<string>;
/**
* A single table bucket encryption configuration object.
* See `encryptionConfiguration` below.
*/
readonly encryptionConfiguration: pulumi.Output<outputs.s3tables.TableBucketEncryptionConfiguration | undefined>;
/**
* A single table bucket maintenance configuration object.
* See `maintenanceConfiguration` below.
*/
readonly maintenanceConfiguration: pulumi.Output<outputs.s3tables.TableBucketMaintenanceConfiguration>;
/**
* 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-buckets-naming.html#table-buckets-naming-rules).
*
* The following arguments are optional:
*/
readonly name: pulumi.Output<string>;
/**
* Account ID of the account that owns the table bucket.
*/
readonly ownerAccountId: pulumi.Output<string>;
/**
* 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>;
/**
* Create a TableBucket 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?: TableBucketArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering TableBucket resources.
*/
export interface TableBucketState {
/**
* ARN of the table bucket.
*/
arn?: pulumi.Input<string>;
/**
* Date and time when the bucket was created.
*/
createdAt?: pulumi.Input<string>;
/**
* A single table bucket encryption configuration object.
* See `encryptionConfiguration` below.
*/
encryptionConfiguration?: pulumi.Input<inputs.s3tables.TableBucketEncryptionConfiguration>;
/**
* A single table bucket maintenance configuration object.
* See `maintenanceConfiguration` below.
*/
maintenanceConfiguration?: pulumi.Input<inputs.s3tables.TableBucketMaintenanceConfiguration>;
/**
* 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-buckets-naming.html#table-buckets-naming-rules).
*
* The following arguments are optional:
*/
name?: pulumi.Input<string>;
/**
* Account ID of the account that owns the table bucket.
*/
ownerAccountId?: pulumi.Input<string>;
/**
* 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>;
}
/**
* The set of arguments for constructing a TableBucket resource.
*/
export interface TableBucketArgs {
/**
* A single table bucket encryption configuration object.
* See `encryptionConfiguration` below.
*/
encryptionConfiguration?: pulumi.Input<inputs.s3tables.TableBucketEncryptionConfiguration>;
/**
* A single table bucket maintenance configuration object.
* See `maintenanceConfiguration` below.
*/
maintenanceConfiguration?: pulumi.Input<inputs.s3tables.TableBucketMaintenanceConfiguration>;
/**
* 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-buckets-naming.html#table-buckets-naming-rules).
*
* The following arguments are optional:
*/
name?: pulumi.Input<string>;
/**
* 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>;
}