@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
119 lines (118 loc) • 4.22 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Resource for managing an Amazon S3 Vectors Vector Bucket policy.
*
* ## Example Usage
*
* ### Basic Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.s3.VectorsVectorBucketPolicy("example", {
* vectorBucketArn: exampleAwsS3vectorsVectorBucket.arn,
* policy: `{
* \\"Version\\": \\"2012-10-17\\",
* \\"Id\\": \\"writePolicy\\",
* \\"Statement\\": [{
* \\"Sid\\": \\"writeStatement\\",
* \\"Effect\\": \\"Allow\\",
* \\"Principal\\": {
* \\"AWS\\": \\"123456789012\\"
* },
* \\"Action\\": [
* \\"s3vectors:PutVectors\\"
* ],
* \\"Resource\\": \\"*\\"
* }]
* }
* `,
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import S3 Vectors Vector Bucket policy using the `vector_bucket_arn`. For example:
*
* ```sh
* $ pulumi import aws:s3/vectorsVectorBucketPolicy:VectorsVectorBucketPolicy example arn:aws:s3vectors:us-west-2:123456789012:bucket/example-bucket
* ```
*/
export declare class VectorsVectorBucketPolicy extends pulumi.CustomResource {
/**
* Get an existing VectorsVectorBucketPolicy 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?: VectorsVectorBucketPolicyState, opts?: pulumi.CustomResourceOptions): VectorsVectorBucketPolicy;
/**
* Returns true if the given object is an instance of VectorsVectorBucketPolicy. 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 VectorsVectorBucketPolicy;
/**
* The policy document.
*/
readonly policy: 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>;
/**
* ARN of the vector bucket.
*
* The following arguments are optional:
*/
readonly vectorBucketArn: pulumi.Output<string>;
/**
* Create a VectorsVectorBucketPolicy 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: VectorsVectorBucketPolicyArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering VectorsVectorBucketPolicy resources.
*/
export interface VectorsVectorBucketPolicyState {
/**
* The policy document.
*/
policy?: 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>;
/**
* ARN of the vector bucket.
*
* The following arguments are optional:
*/
vectorBucketArn?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a VectorsVectorBucketPolicy resource.
*/
export interface VectorsVectorBucketPolicyArgs {
/**
* The policy document.
*/
policy: 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>;
/**
* ARN of the vector bucket.
*
* The following arguments are optional:
*/
vectorBucketArn: pulumi.Input<string>;
}