BucketPolicy

class aws_cdk.aws_s3.BucketPolicy(scope, id, *, bucket, removal_policy=None)

Bases: aws_cdk.core.Resource

Applies an Amazon S3 bucket policy to an Amazon S3 bucket.

Parameters
  • scope (Construct) –

  • id (str) –

  • bucket (IBucket) – The Amazon S3 bucket that the policy applies to.

  • removal_policy (Optional[RemovalPolicy]) – Policy to apply when the policy is removed from this stack. Default: - RemovalPolicy.DESTROY.

Methods

apply_removal_policy(removal_policy)

Sets the removal policy for the BucketPolicy.

Parameters

removal_policy (RemovalPolicy) – the RemovalPolicy to set.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

document

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

For more information, see Access Policy Language Overview in the Amazon Simple Storage Service Developer Guide.

Return type

PolicyDocument

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

Return type

ResourceEnvironment

node

The construct tree node associated with this construct.

Return type

ConstructNode

stack

The stack in which this resource is defined.

Return type

Stack

Static Methods

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool