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:

IEnvironmentAware, IInspectable, IVectorBucketPolicyRef, 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.263Z")
@Stability(Stable)
public class CfnVectorBucketPolicy
extends CfnResource
implements IInspectable, IVectorBucketPolicyRef

Resource Type definition for AWS::S3Vectors::VectorBucketPolicy.

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:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnVectorBucketPolicy.Builder	A fluent builder for CfnVectorBucketPolicy.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.s3vectors.IVectorBucketPolicyRef

IVectorBucketPolicyRef.Jsii$Default, IVectorBucketPolicyRef.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnVectorBucketPolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnVectorBucketPolicy(software.amazon.jsii.JsiiObjectRef objRef)
	CfnVectorBucketPolicy(software.constructs.Construct scope, String id, CfnVectorBucketPolicyProps props)

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	getCfnProperties()
Object	getPolicy()
String	getVectorBucketArn()	The Amazon Resource Name (ARN) of the vector bucket.
String	getVectorBucketName()	The name of the vector bucket.
VectorBucketPolicyReference	getVectorBucketPolicyRef()	A reference to a VectorBucketPolicy resource.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setPolicy(Object value)
void	setVectorBucketArn(String value)	The Amazon Resource Name (ARN) of the vector bucket.
void	setVectorBucketName(String value)	The name of the vector bucket.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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)

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

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()

setPolicy

@Stability(Stable)
public void setPolicy(@NotNull
 Object value)

getVectorBucketArn

@Stability(Stable)
@Nullable
public String getVectorBucketArn()

The Amazon Resource Name (ARN) of the vector bucket.

setVectorBucketArn

@Stability(Stable)
public void setVectorBucketArn(@Nullable
 String value)

The Amazon Resource Name (ARN) of 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.