@cdklabs/generative-ai-cdk-constructs
@cdklabs/generative-ai-cdk-constructs / s3vectors / VectorBucket
S3 vector bucket resource for AWS S3 vector buckets. You can use this resource to create, modify, and manage vector buckets.
https://docs.aws.amazon.com/s3vectors/latest/userguide/what-is-s3vectors.html
AWS::S3::VectorBucket
new VectorBucket(
scope,id,props):VectorBucket
Construct
string
VectorBucketProps = {}
VectorBucket
protectedautoCreatePolicy:boolean=true
Indicates if a vector bucket resource policy should automatically be created upon
the first call to addToResourcePolicy.
VectorBucketBase.autoCreatePolicy
readonlyoptionalcreationTime:string
The timestamp when the vector bucket was created, in ISO 8601 format.
readonlyoptionalencryptionKey:IKey
KMS encryption key associated with this cluster.
VectorBucketBase.encryptionKey
readonlyenv:ResourceEnvironment
The environment this resource belongs to.
For resources that are created and managed in a Stack (those created by
creating new class instances like new Role(), new Bucket(), etc.), this
is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like
Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be
different than the stack they were imported into.
readonlynode:Node
The tree node.
protectedreadonlyphysicalName:string
Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
This value will resolve to one of the following:
"my-awesome-bucket")undefined, when a name should be generated by CloudFormation
optionalpolicy:VectorBucketPolicy
The resource policy associated with this vector bucket.
If autoCreatePolicy is true, a VectorBucketPolicy will be created upon the
first call to addToResourcePolicy.
readonlystack:Stack
The stack in which this resource is defined.
readonlyvectorBucketArn:string
The ARN of the cluster
VectorBucketBase.vectorBucketArn
readonlyvectorBucketName:string
The name of the vector bucket
VectorBucketBase.vectorBucketName
_enableCrossEnvironment():
void
Internal
Called when this resource is referenced across environments (account/region) to order to request that a physical name will be generated for this resource during synthesis, so the resource can be referenced through its absolute name/arn.
void
VectorBucketBase._enableCrossEnvironment
addToResourcePolicy(
permission):AddToResourcePolicyResult
Adds a statement to the resource policy for a principal (i.e.
account/role/service) to perform actions on this bucket and/or its
contents. Use bucketArn to obtain ARNs for
this bucket or objects.
Note that the policy statement may or may not be added to the policy.
For example, when an IBucket is created from an existing bucket,
it’s not possible to tell whether the bucket already has a policy
attached, let alone to re-use that policy to add more statements to it.
So it’s safest to do nothing in these cases.
PolicyStatement
the policy statement to be added to the bucket’s policy.
AddToResourcePolicyResult
metadata about the execution of this method. If the policy
was not added, the value of statementAdded will be false. You
should always check this value to make sure that the operation was
actually carried out. Otherwise, synthesis and deploy will terminate
silently, which may be confusing.
VectorBucketBase.addToResourcePolicy
applyRemovalPolicy(
policy):void
Apply the given removal policy to this resource
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN).
RemovalPolicy
void
VectorBucketBase.applyRemovalPolicy
protectedgeneratePhysicalName():string
string
VectorBucketBase.generatePhysicalName
protectedgetResourceArnAttribute(arnAttr,arnComponents):string
Returns an environment-sensitive token that should be used for the
resource’s “ARN” attribute (e.g. bucket.bucketArn).
Normally, this token will resolve to arnAttr, but if the resource is
referenced across environments, arnComponents will be used to synthesize
a concrete ARN with the resource’s physical name. Make sure to reference
this.physicalName in arnComponents.
string
The CFN attribute which resolves to the ARN of the resource.
Commonly it will be called “Arn” (e.g. resource.attrArn), but sometimes
it’s the CFN resource’s ref.
ArnComponents
The format of the ARN of this resource. You must
reference this.physicalName somewhere within the ARN in order for
cross-environment references to work.
string
VectorBucketBase.getResourceArnAttribute
protectedgetResourceNameAttribute(nameAttr):string
Returns an environment-sensitive token that should be used for the
resource’s “name” attribute (e.g. bucket.bucketName).
Normally, this token will resolve to nameAttr, but if the resource is
referenced across environments, it will be resolved to this.physicalName,
which will be a concrete name.
string
The CFN attribute which resolves to the resource’s name.
Commonly this is the resource’s ref.
string
VectorBucketBase.getResourceNameAttribute
grantDelete(
grantee,indexIds):Grant
Grants IAM actions to the IAM Principal to delete the vector bucket and indexes
IGrantable
The IAM principal to grant permissions to
any = '*'
Restrict the permission to a certain set of indexes (default ‘*’). Parameter type is any but string[] should be passed in.
Grant
An IAM Grant object representing the granted permissions
grantRead(
grantee,indexIds):Grant
Grants IAM actions to the IAM Principal to read from the vector bucket and indexes
IGrantable
The IAM principal to grant permissions to
any = '*'
Restrict the permission to a certain set of indexes (default ‘*’). Parameter type is any but string[] should be passed in.
Grant
An IAM Grant object representing the granted permissions
grantWrite(
grantee,indexIds):Grant
Grants IAM actions to the IAM Principal to write to the vector bucket and indexes
IGrantable
The IAM principal to grant permissions to
any = '*'
Restrict the permission to a certain set of indexes (default ‘*’). Parameter type is any but string[] should be passed in.
Grant
An IAM Grant object representing the granted permissions
toString():
string
Returns a string representation of this construct.
string
staticfromCfnVectorBucket(cfnVectorBucket):IVectorBucket
CfnVectorBucket
staticfromVectorBucketArn(scope,id,vectorBucketArn):IVectorBucket
Creates a VectorBucket construct that represents an external vector bucket by ARN.
Construct
The parent creating construct (usually this).
string
The construct’s name.
string
The ARN of the vector bucket.
A VectorBucket construct.
staticfromVectorBucketAttributes(scope,id,attrs):IVectorBucket
Creates a VectorBucket construct that represents an external vector bucket.
Construct
The parent creating construct (usually this).
string
The construct’s name.
A VectorBucketAttributes object. Can be obtained from a call to
vectorBucket.export() or manually created.
staticfromVectorBucketName(scope,id,vectorBucketName):IVectorBucket
Creates a VectorBucket construct that represents an external vector bucket by name.
Construct
The parent creating construct (usually this).
string
The construct’s name.
string
The name of the vector bucket.
A VectorBucket construct.
staticisConstruct(x):x is Construct
Checks if x is a construct.
Use this method instead of instanceof to properly detect Construct
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on
disk are seen as independent, completely different libraries. As a
consequence, the class Construct in each copy of the constructs library
is seen as a different class, and an instance of one class will not test as
instanceof the other class. npm install will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the constructs
library can be accidentally installed, and instanceof will behave
unpredictably. It is safest to avoid using instanceof, and using
this type-testing method instead.
any
Any object
x is Construct
true if x is an object created from a class which extends Construct.
staticisOwnedResource(construct):boolean
Returns true if the construct was created by CDK, and false otherwise
IConstruct
boolean
VectorBucketBase.isOwnedResource
staticisResource(construct):construct is Resource
Check whether the given construct is a Resource
IConstruct
construct is Resource