Package software.amazon.awscdk.services.s3vectors

Class CfnVectorBucketPolicy

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.s3vectors.CfnVectorBucketPolicy
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IVectorBucketPolicyRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:17.280Z") @Stability(Stable) public class CfnVectorBucketPolicy extends CfnResource implements IInspectable, IVectorBucketPolicyRef
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.services.s3vectors.*;
 Object policy;
 CfnVectorBucketPolicy cfnVectorBucketPolicy = CfnVectorBucketPolicy.Builder.create(this, "MyCfnVectorBucketPolicy")
         .policy(policy)
         // the properties below are optional
         .vectorBucketArn("vectorBucketArn")
         .vectorBucketName("vectorBucketName")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnVectorBucketPolicy

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

    • CfnVectorBucketPolicy

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

    • CfnVectorBucketPolicy

      @Stability(Stable) public CfnVectorBucketPolicy(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnVectorBucketPolicyProps props)
      Create a new AWS::S3Vectors::VectorBucketPolicy.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • isCfnVectorBucketPolicy

      @Stability(Stable) @NotNull public static Boolean isCfnVectorBucketPolicy(@NotNull Object x)
      Checks whether the given object is a CfnVectorBucketPolicy.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getVectorBucketPolicyRef

      @Stability(Stable) @NotNull public VectorBucketPolicyReference getVectorBucketPolicyRef()
      A reference to a VectorBucketPolicy resource.
      Specified by:
      getVectorBucketPolicyRef in interface IVectorBucketPolicyRef

    • getPolicy

      @Stability(Stable) @NotNull public Object getPolicy()
      A policy document containing permissions to add to the specified vector bucket.

    • setPolicy

      @Stability(Stable) public void setPolicy(@NotNull Object value)
      A policy document containing permissions to add to the specified vector bucket.

    • getVectorBucketArn

      @Stability(Stable) @Nullable public String getVectorBucketArn()
      The Amazon Resource Name (ARN) of the S3 vector bucket to which the policy applies.

    • setVectorBucketArn

      @Stability(Stable) public void setVectorBucketArn(@Nullable String value)
      The Amazon Resource Name (ARN) of the S3 vector bucket to which the policy applies.

    • getVectorBucketName

      @Stability(Stable) @Nullable public String getVectorBucketName()
      The name of the S3 vector bucket to which the policy applies.

    • setVectorBucketName

      @Stability(Stable) public void setVectorBucketName(@Nullable String value)
      The name of the S3 vector bucket to which the policy applies.