Package software.amazon.awscdk.services.s3vectors

Interface CfnVectorBucketPolicyProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnVectorBucketPolicyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:17.281Z")
@Stability(Stable)
public interface CfnVectorBucketPolicyProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnVectorBucketPolicy.

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;
 CfnVectorBucketPolicyProps cfnVectorBucketPolicyProps = CfnVectorBucketPolicyProps.builder()
         .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	Interface	Description
static final class	CfnVectorBucketPolicyProps.Builder	A builder for CfnVectorBucketPolicyProps
static final class	CfnVectorBucketPolicyProps.Jsii$Proxy	An implementation for CfnVectorBucketPolicyProps

Method Summary

Modifier and Type	Method	Description
static CfnVectorBucketPolicyProps.Builder	builder()
Object	getPolicy()	A policy document containing permissions to add to the specified vector bucket.
default String	getVectorBucketArn()	The Amazon Resource Name (ARN) of the S3 vector bucket to which the policy applies.
default String	getVectorBucketName()	The name of the S3 vector bucket to which the policy applies.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPolicy

@Stability(Stable)
@NotNull
Object getPolicy()

A policy document containing permissions to add to the specified vector bucket.

In IAM , you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM .

See Also:

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

getVectorBucketArn

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

The Amazon Resource Name (ARN) of the S3 vector bucket to which the policy applies.

See Also:

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

getVectorBucketName

@Stability(Stable)
@Nullable
default String getVectorBucketName()

The name of the S3 vector bucket to which the policy applies.

See Also:

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

builder

@Stability(Stable)
static CfnVectorBucketPolicyProps.Builder builder()

Returns:

a CfnVectorBucketPolicyProps.Builder of CfnVectorBucketPolicyProps