class CfnVectorBucketPolicyPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.S3Vectors.Mixins.CfnVectorBucketPolicyPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awss3vectors/mixins#CfnVectorBucketPolicyPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.s3vectors.mixins.CfnVectorBucketPolicyPropsMixin
Python	aws_cdk.mixins_preview.aws_s3vectors.mixins.CfnVectorBucketPolicyPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_s3vectors » mixins » CfnVectorBucketPolicyPropsMixin

Implements IMixin

Extends Mixin

The AWS::S3Vectors::VectorBucketPolicy resource defines an Amazon S3 vector bucket policy to control access to an Amazon S3 vector bucket.

Vector bucket policies are written in JSON and allow you to grant or deny permissions across all (or a subset of) objects within a vector bucket.

You must specify either VectorBucketName or VectorBucketArn to identify the target bucket.

To control how AWS CloudFormation handles the vector bucket policy when the stack is deleted, you can set a deletion policy for your policy. You can choose to retain the policy or to delete the policy. For more information, see DeletionPolicy attribute .

• Permissions - The required permissions for CloudFormation to use are based on the operations that are performed on the stack.

• Create

• s3vectors:GetVectorBucketPolicy

• s3vectors:PutVectorBucketPolicy

• Read

• s3vectors:GetVectorBucketPolicy

• Update

• s3vectors:GetVectorBucketPolicy

• s3vectors:PutVectorBucketPolicy

• Delete

• s3vectors:GetVectorBucketPolicy

• s3vectors:DeleteVectorBucketPolicy

• List

• s3vectors:GetVectorBucketPolicy

• s3vectors:ListVectorBuckets

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-vectorbucketpolicy.html

Example

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

declare const policy: any;
const cfnVectorBucketPolicyPropsMixin = new s3vectors_mixins.CfnVectorBucketPolicyPropsMixin({
  policy: policy,
  vectorBucketArn: 'vectorBucketArn',
  vectorBucketName: 'vectorBucketName',
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnVectorBucketPolicyPropsMixin(props: CfnVectorBucketPolicyMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnVectorBucketPolicyMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::S3Vectors::VectorBucketPolicy.

Properties

Name	Type	Description
props	CfnVectorBucketPolicyMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnVectorBucketPolicyMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.