CfnVectorBucketPolicyPropsMixin

class aws_cdk.mixins_preview.aws_s3vectors.mixins.CfnVectorBucketPolicyPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::S3Vectors::VectorBucketPolicy resource defines an Amazon S3 vector bucket policy to control access to an Amazon S3 vector bucket.

Vector bucket policies are written in JSON and allow you to grant or deny permissions across all (or a subset of) objects within a vector bucket.

You must specify either VectorBucketName or VectorBucketArn to identify the target bucket.

To control how AWS CloudFormation handles the vector bucket policy when the stack is deleted, you can set a deletion policy for your policy. You can choose to retain the policy or to delete the policy. For more information, see DeletionPolicy attribute .

Permissions - The required permissions for CloudFormation to use are based on the operations that are performed on the stack.
Create
s3vectors:GetVectorBucketPolicy
s3vectors:PutVectorBucketPolicy
Read
s3vectors:GetVectorBucketPolicy
Update
s3vectors:GetVectorBucketPolicy
s3vectors:PutVectorBucketPolicy
Delete
s3vectors:GetVectorBucketPolicy
s3vectors:DeleteVectorBucketPolicy
List
s3vectors:GetVectorBucketPolicy
s3vectors:ListVectorBuckets

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-vectorbucketpolicy.html
CloudformationResource:: AWS::S3Vectors::VectorBucketPolicy
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_s3vectors import mixins as s3vectors_mixins

# policy: Any

cfn_vector_bucket_policy_props_mixin = s3vectors_mixins.CfnVectorBucketPolicyPropsMixin(s3vectors_mixins.CfnVectorBucketPolicyMixinProps(
    policy=policy,
    vector_bucket_arn="vectorBucketArn",
    vector_bucket_name="vectorBucketName"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::S3Vectors::VectorBucketPolicy.

Parameters:

props (Union[CfnVectorBucketPolicyMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['policy', 'vectorBucketArn', 'vectorBucketName']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental