Package software.amazon.awscdk.services.s3vectors

Class CfnVectorBucketPolicy.Builder

java.lang.Object

software.amazon.awscdk.services.s3vectors.CfnVectorBucketPolicy.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnVectorBucketPolicy>

Enclosing class:

CfnVectorBucketPolicy

@Stability(Stable)
public static final class CfnVectorBucketPolicy.Builder
extends Object
implements software.amazon.jsii.Builder<CfnVectorBucketPolicy>

A fluent builder for CfnVectorBucketPolicy.

Method Summary

Modifier and Type	Method	Description
CfnVectorBucketPolicy	build()
static CfnVectorBucketPolicy.Builder	create(software.constructs.Construct scope, String id)
CfnVectorBucketPolicy.Builder	policy(Object policy)	A policy document containing permissions to add to the specified vector bucket.
CfnVectorBucketPolicy.Builder	vectorBucketArn(String vectorBucketArn)	The Amazon Resource Name (ARN) of the S3 vector bucket to which the policy applies.
CfnVectorBucketPolicy.Builder	vectorBucketName(String vectorBucketName)	The name of the S3 vector bucket to which the policy applies.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnVectorBucketPolicy.Builder create(software.constructs.Construct scope,
 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.

Returns:

a new instance of CfnVectorBucketPolicy.Builder.

policy

@Stability(Stable)
public CfnVectorBucketPolicy.Builder policy(Object policy)

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 .

Parameters:

policy - A policy document containing permissions to add to the specified vector bucket. This parameter is required.

Returns:

this

See Also:

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

vectorBucketArn

@Stability(Stable)
public CfnVectorBucketPolicy.Builder vectorBucketArn(String vectorBucketArn)

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

Parameters:

vectorBucketArn - The Amazon Resource Name (ARN) of the S3 vector bucket to which the policy applies. This parameter is required.

Returns:

this

See Also:

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

vectorBucketName

@Stability(Stable)
public CfnVectorBucketPolicy.Builder vectorBucketName(String vectorBucketName)

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

Parameters:

vectorBucketName - The name of the S3 vector bucket to which the policy applies. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnVectorBucketPolicy build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnVectorBucketPolicy>

Returns:

a newly built instance of CfnVectorBucketPolicy.