Package software.amazon.awscdk.cfnpropertymixins.services.s3vectors

Class CfnVectorBucketPolicyPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.s3vectors.CfnVectorBucketPolicyPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnVectorBucketPolicyPropsMixin>

Enclosing class:

CfnVectorBucketPolicyPropsMixin

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

A fluent builder for CfnVectorBucketPolicyPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnVectorBucketPolicyPropsMixin	build()
static CfnVectorBucketPolicyPropsMixin.Builder	create()
static CfnVectorBucketPolicyPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnVectorBucketPolicyPropsMixin.Builder	policy(Object policy)	A policy document containing permissions to add to the specified vector bucket.
CfnVectorBucketPolicyPropsMixin.Builder	vectorBucketArn(String vectorBucketArn)	The Amazon Resource Name (ARN) of the S3 vector bucket to which the policy applies.
CfnVectorBucketPolicyPropsMixin.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 CfnVectorBucketPolicyPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnVectorBucketPolicyPropsMixin.Builder.

create

@Stability(Stable)
public static CfnVectorBucketPolicyPropsMixin.Builder create()

Returns:

a new instance of CfnVectorBucketPolicyPropsMixin.Builder.

policy

@Stability(Stable)
public CfnVectorBucketPolicyPropsMixin.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 CfnVectorBucketPolicyPropsMixin.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 CfnVectorBucketPolicyPropsMixin.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 CfnVectorBucketPolicyPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnVectorBucketPolicyPropsMixin.