software.amazon.awscdk.services.s3

Class BucketPolicy.Builder

java.lang.Object

software.amazon.awscdk.services.s3.BucketPolicy.Builder

Enclosing class:

BucketPolicy

public static final class BucketPolicy.Builder
extends java.lang.Object

A fluent builder for BucketPolicy.

Method Summary

Modifier and Type	Method and Description
BucketPolicy.Builder	bucket(IBucket bucket) The Amazon S3 bucket that the policy applies to.
BucketPolicy	build()
static BucketPolicy.Builder	create(software.constructs.Construct scope, java.lang.String id)
BucketPolicy.Builder	removalPolicy(RemovalPolicy removalPolicy) Policy to apply when the policy is removed from this stack.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static BucketPolicy.Builder create(software.constructs.Construct scope,
                                          java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of BucketPolicy.Builder.

bucket

public BucketPolicy.Builder bucket(IBucket bucket)

The Amazon S3 bucket that the policy applies to.

Parameters:

bucket - The Amazon S3 bucket that the policy applies to. This parameter is required.

Returns:

this

removalPolicy

public BucketPolicy.Builder removalPolicy(RemovalPolicy removalPolicy)

Policy to apply when the policy is removed from this stack.

Default: - RemovalPolicy.DESTROY.

Parameters:

removalPolicy - Policy to apply when the policy is removed from this stack. This parameter is required.

Returns:

this

build

public BucketPolicy build()