Package software.amazon.awscdk.cfnpropertymixins.services.s3vectors

Class CfnVectorBucketPolicyPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.s3vectors.CfnVectorBucketPolicyPropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:20:04.851Z") @Stability(Stable) public class CfnVectorBucketPolicyPropsMixin extends Mixin implements software.constructs.IMixin
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

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.s3vectors.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 Object policy;
 CfnVectorBucketPolicyPropsMixin cfnVectorBucketPolicyPropsMixin = CfnVectorBucketPolicyPropsMixin.Builder.create(CfnVectorBucketPolicyMixinProps.builder()
         .policy(policy)
         .vectorBucketArn("vectorBucketArn")
         .vectorBucketName("vectorBucketName")
         .build())
 .strategy(mergeStrategy)
 .build();

See Also:

  • Field Details

    • CFN_PROPERTY_KEYS

      @Stability(Stable) protected static final List<String> CFN_PROPERTY_KEYS

  • Constructor Details

    • CfnVectorBucketPolicyPropsMixin

      protected CfnVectorBucketPolicyPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnVectorBucketPolicyPropsMixin

      protected CfnVectorBucketPolicyPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnVectorBucketPolicyPropsMixin

      @Stability(Stable) public CfnVectorBucketPolicyPropsMixin(@NotNull CfnVectorBucketPolicyMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::S3Vectors::VectorBucketPolicy.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnVectorBucketPolicyPropsMixin

      @Stability(Stable) public CfnVectorBucketPolicyPropsMixin(@NotNull CfnVectorBucketPolicyMixinProps props)
      Create a mixin to apply properties to AWS::S3Vectors::VectorBucketPolicy.

      Parameters:
      props - L1 properties to apply. This parameter is required.

  • Method Details

    • applyTo

      @Stability(Stable) public void applyTo(@NotNull software.constructs.IConstruct construct)
      Apply the mixin properties to the construct.

      Specified by:
      applyTo in interface software.constructs.IMixin
      Specified by:
      applyTo in class Mixin
      Parameters:
      construct - This parameter is required.

    • supports

      @Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct)
      Check if this mixin supports the given construct.

      Specified by:
      supports in interface software.constructs.IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

      @Stability(Stable) @NotNull protected CfnVectorBucketPolicyMixinProps getProps()

    • getStrategy

      @Stability(Stable) @NotNull protected IMergeStrategy getStrategy()