@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
72 lines (71 loc) • 3.8 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Resource Type definition for AWS::S3Vectors::VectorBucket
*/
export declare class VectorBucket extends pulumi.CustomResource {
/**
* Get an existing VectorBucket 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 opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): VectorBucket;
/**
* Returns true if the given object is an instance of VectorBucket. 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 VectorBucket;
/**
* Returns the date and time when the vector bucket was created.
*
* Example: `2024-12-21T10:30:00Z`
*/
readonly creationTime: pulumi.Output<string>;
/**
* The encryption configuration for the vector bucket.
*/
readonly encryptionConfiguration: pulumi.Output<outputs.s3vectors.VectorBucketEncryptionConfiguration | undefined>;
/**
* Returns the Amazon Resource Name (ARN) of the specified vector bucket.
*
* Example: `arn:aws:s3vectors:us-east-1:123456789012:bucket/amzn-s3-demo-vector-bucket`
*/
readonly vectorBucketArn: pulumi.Output<string>;
/**
* A name for the vector bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). The bucket name must be unique in the same AWS account for each AWS Region. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the bucket name.
*
* The bucket name must be between 3 and 63 characters long and must not contain uppercase characters or underscores.
*
* > If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name.
*/
readonly vectorBucketName: pulumi.Output<string | undefined>;
/**
* Create a VectorBucket 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?: VectorBucketArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a VectorBucket resource.
*/
export interface VectorBucketArgs {
/**
* The encryption configuration for the vector bucket.
*/
encryptionConfiguration?: pulumi.Input<inputs.s3vectors.VectorBucketEncryptionConfigurationArgs>;
/**
* A name for the vector bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). The bucket name must be unique in the same AWS account for each AWS Region. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the bucket name.
*
* The bucket name must be between 3 and 63 characters long and must not contain uppercase characters or underscores.
*
* > If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name.
*/
vectorBucketName?: pulumi.Input<string>;
}