software.amazon.awscdk.services.s3

Class BucketPolicy

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.s3.BucketPolicy

All Implemented Interfaces:

IResource, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.29.0 (build 41df200)",
           date="2021-06-02T09:55:36.285Z")
 @Stability(value=Experimental)
public class BucketPolicy
extends Resource

(experimental) Applies an Amazon S3 bucket policy to an Amazon S3 bucket.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BucketPolicy.Builder (experimental) A fluent builder for BucketPolicy.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor and Description
	BucketPolicy(software.constructs.Construct scope, String id, BucketPolicyProps props)
protected	BucketPolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	BucketPolicy(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
void	applyRemovalPolicy(RemovalPolicy removalPolicy) (experimental) Sets the removal policy for the BucketPolicy.
PolicyDocument	getDocument() (experimental) A policy document containing permissions to add to the specified bucket.

Methods inherited from class software.amazon.awscdk.Resource

generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

BucketPolicy

protected BucketPolicy(software.amazon.jsii.JsiiObjectRef objRef)

BucketPolicy

protected BucketPolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

BucketPolicy

@Stability(value=Experimental)
public BucketPolicy(@NotNull
                                                   software.constructs.Construct scope,
                                                   @NotNull
                                                   String id,
                                                   @NotNull
                                                   BucketPolicyProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

applyRemovalPolicy

@Stability(value=Experimental)
public void applyRemovalPolicy(@NotNull
                                                              RemovalPolicy removalPolicy)

(experimental) Sets the removal policy for the BucketPolicy.

Overrides:

applyRemovalPolicy in class Resource

Parameters:

removalPolicy - the RemovalPolicy to set. This parameter is required.

getDocument

@Stability(value=Experimental)
 @NotNull
public PolicyDocument getDocument()

(experimental) 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.