interface CfnVectorBucketPolicyProps

Language	Type name
.NET	`Amazon.CDK.AWS.S3Vectors.CfnVectorBucketPolicyProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awss3vectors#CfnVectorBucketPolicyProps`
Java	`software.amazon.awscdk.services.s3vectors.CfnVectorBucketPolicyProps`
Python	`aws_cdk.aws_s3vectors.CfnVectorBucketPolicyProps`
TypeScript	`aws-cdk-lib` » `aws_s3vectors` » `CfnVectorBucketPolicyProps`

Properties for defining a CfnVectorBucketPolicy.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_s3vectors as s3vectors } from 'aws-cdk-lib';

declare const policy: any;
const cfnVectorBucketPolicyProps: s3vectors.CfnVectorBucketPolicyProps = {
  policy: policy,

  // the properties below are optional
  vectorBucketArn: 'vectorBucketArn',
  vectorBucketName: 'vectorBucketName',
};

Properties

Name	Type	Description
policy	`any`	A policy document containing permissions to add to the specified vector bucket.
vectorBucketArn?	`string`	The Amazon Resource Name (ARN) of the S3 vector bucket to which the policy applies.
vectorBucketName?	`string`	The name of the S3 vector bucket to which the policy applies.

policy

Type: any

A policy document containing permissions to add to the specified vector bucket.

In IAM , you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM .

vectorBucketArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the S3 vector bucket to which the policy applies.

vectorBucketName?