@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
176 lines (175 loc) • 8.31 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 Vectors Vector Bucket.
*
* ## Example Usage
*
* ### Basic Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.s3.VectorsVectorBucket("example", {vectorBucketName: "example-bucket"});
* ```
*
* ### Encryption
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.s3.VectorsVectorBucket("example", {
* vectorBucketName: "example-bucket",
* encryptionConfigurations: [{
* sseType: "aws:kms",
* kmsKeyArn: exampleAwsKmsKey.arn,
* }],
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import S3 Vectors Vector Bucket using the `vector_bucket_arn`. For example:
*
* ```sh
* $ pulumi import aws:s3/vectorsVectorBucket:VectorsVectorBucket example arn:aws:s3vectors:us-west-2:123456789012:bucket/example-bucket
* ```
*/
export declare class VectorsVectorBucket extends pulumi.CustomResource {
/**
* Get an existing VectorsVectorBucket 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?: VectorsVectorBucketState, opts?: pulumi.CustomResourceOptions): VectorsVectorBucket;
/**
* Returns true if the given object is an instance of VectorsVectorBucket. 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 VectorsVectorBucket;
/**
* Date and time when the vector bucket was created.
*/
readonly creationTime: pulumi.Output<string>;
/**
* Encryption configuration for the vector bucket. See Encryption Configuration below for more details.
*/
readonly encryptionConfigurations: pulumi.Output<outputs.s3.VectorsVectorBucketEncryptionConfiguration[]>;
/**
* Boolean that indicates all indexes and vectors should be deleted from the vector bucket *when the vector bucket is destroyed* so that the vector bucket can be destroyed without error. Once this parameter is set to `true`, there must be a successful `pulumi up` run before a destroy is required to update this value in the resource state. Without a successful `pulumi up` after this parameter is set, this flag will have no effect. If setting this field in the same operation that would require replacing the vector bucket or destroying the vector bucket, this flag will not work.
*/
readonly forceDestroy: pulumi.Output<boolean>;
/**
* 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>;
/**
* Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
readonly tagsAll: pulumi.Output<{
[key: string]: string;
}>;
/**
* ARN of the vector bucket.
*/
readonly vectorBucketArn: pulumi.Output<string>;
/**
* Name of the vector bucket.
*
* The following arguments are optional:
*/
readonly vectorBucketName: pulumi.Output<string>;
/**
* Create a VectorsVectorBucket 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: VectorsVectorBucketArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering VectorsVectorBucket resources.
*/
export interface VectorsVectorBucketState {
/**
* Date and time when the vector bucket was created.
*/
creationTime?: pulumi.Input<string>;
/**
* Encryption configuration for the vector bucket. See Encryption Configuration below for more details.
*/
encryptionConfigurations?: pulumi.Input<pulumi.Input<inputs.s3.VectorsVectorBucketEncryptionConfiguration>[]>;
/**
* Boolean that indicates all indexes and vectors should be deleted from the vector bucket *when the vector bucket is destroyed* so that the vector bucket can be destroyed without error. Once this parameter is set to `true`, there must be a successful `pulumi up` run before a destroy is required to update this value in the resource state. Without a successful `pulumi up` after this parameter is set, this flag will have no effect. If setting this field in the same operation that would require replacing the vector bucket or destroying the vector bucket, this flag will not work.
*/
forceDestroy?: pulumi.Input<boolean>;
/**
* 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>;
/**
* Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
tagsAll?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* ARN of the vector bucket.
*/
vectorBucketArn?: pulumi.Input<string>;
/**
* Name of the vector bucket.
*
* The following arguments are optional:
*/
vectorBucketName?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a VectorsVectorBucket resource.
*/
export interface VectorsVectorBucketArgs {
/**
* Encryption configuration for the vector bucket. See Encryption Configuration below for more details.
*/
encryptionConfigurations?: pulumi.Input<pulumi.Input<inputs.s3.VectorsVectorBucketEncryptionConfiguration>[]>;
/**
* Boolean that indicates all indexes and vectors should be deleted from the vector bucket *when the vector bucket is destroyed* so that the vector bucket can be destroyed without error. Once this parameter is set to `true`, there must be a successful `pulumi up` run before a destroy is required to update this value in the resource state. Without a successful `pulumi up` after this parameter is set, this flag will have no effect. If setting this field in the same operation that would require replacing the vector bucket or destroying the vector bucket, this flag will not work.
*/
forceDestroy?: pulumi.Input<boolean>;
/**
* 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>;
/**
* Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Name of the vector bucket.
*
* The following arguments are optional:
*/
vectorBucketName: pulumi.Input<string>;
}