CfnVectorBucketPolicyProps

class aws_cdk.aws_s3vectors.CfnVectorBucketPolicyProps(*, policy, vector_bucket_arn=None, vector_bucket_name=None)

Bases: object

Properties for defining a CfnVectorBucketPolicy.

Parameters:

  • policy (Any) – 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 .

  • vector_bucket_arn (Optional[str]) – The Amazon Resource Name (ARN) of the S3 vector bucket to which the policy applies.

  • vector_bucket_name (Optional[str]) – The name of the S3 vector bucket to which the policy applies.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_s3vectors as s3vectors

# policy: Any

cfn_vector_bucket_policy_props = s3vectors.CfnVectorBucketPolicyProps(
    policy=policy,

    # the properties below are optional
    vector_bucket_arn="vectorBucketArn",
    vector_bucket_name="vectorBucketName"
)

Attributes

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 .

See:

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

vector_bucket_arn

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

See:

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

vector_bucket_name

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

See:

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