Package software.amazon.awscdk.services.s3vectors

Class CfnVectorBucket

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.CfnVectorBucket
All Implemented Interfaces:
IEnvironmentAware, IInspectable, IVectorBucketRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:40:14.262Z") @Stability(Stable) public class CfnVectorBucket extends CfnResource implements IInspectable, IVectorBucketRef
Resource Type definition for AWS::S3Vectors::VectorBucket.

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.*;
 CfnVectorBucket cfnVectorBucket = CfnVectorBucket.Builder.create(this, "MyCfnVectorBucket")
         .encryptionConfiguration(EncryptionConfigurationProperty.builder()
                 .kmsKeyArn("kmsKeyArn")
                 .sseType("sseType")
                 .build())
         .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

    • CfnVectorBucket

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

    • CfnVectorBucket

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

    • CfnVectorBucket

      @Stability(Stable) public CfnVectorBucket(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnVectorBucketProps props)
      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.

    • CfnVectorBucket

      @Stability(Stable) public CfnVectorBucket(@NotNull software.constructs.Construct scope, @NotNull String id)
      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.

  • Method Details

    • 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.

    • getAttrCreationTime

      @Stability(Stable) @NotNull public String getAttrCreationTime()
      Date and time when the vector bucket was created.

    • getAttrVectorBucketArn

      @Stability(Stable) @NotNull public String getAttrVectorBucketArn()
      The Amazon Resource Name (ARN) of the vector bucket.

    • getCfnProperties

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

    • getVectorBucketRef

      @Stability(Stable) @NotNull public VectorBucketReference getVectorBucketRef()
      A reference to a VectorBucket resource.
      Specified by:
      getVectorBucketRef in interface IVectorBucketRef

    • getEncryptionConfiguration

      @Stability(Stable) @Nullable public Object getEncryptionConfiguration()
      The encryption configuration for the vector bucket.

      Returns union: either IResolvable or CfnVectorBucket.EncryptionConfigurationProperty

    • setEncryptionConfiguration

      @Stability(Stable) public void setEncryptionConfiguration(@Nullable IResolvable value)
      The encryption configuration for the vector bucket.

    • setEncryptionConfiguration

      @Stability(Stable) public void setEncryptionConfiguration(@Nullable CfnVectorBucket.EncryptionConfigurationProperty value)
      The encryption configuration for the vector bucket.

    • getVectorBucketName

      @Stability(Stable) @Nullable public String getVectorBucketName()
      The name of the vector bucket.

    • setVectorBucketName

      @Stability(Stable) public void setVectorBucketName(@Nullable String value)
      The name of the vector bucket.