software.amazon.awscdk.services.s3

Class Bucket

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.s3.BucketBase

software.amazon.awscdk.services.s3.Bucket

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.729Z")
 @Stability(value=Stable)
public class Bucket
extends BucketBase

An S3 bucket with associated policy objects.

This bucket does not yet have all features that exposed by the underlying BucketResource.

Example:

 // Example automatically generated from non-compiling source. May contain errors.
 Bucket.Builder.create(scope, "Bucket")
         .blockPublicAccess(BlockPublicAccess.getBLOCK_ALL())
         .encryption(BucketEncryption.getS3_MANAGED())
         .enforceSSL(true)
         .versioned(true)
         .removalPolicy(RemovalPolicy.getRETAIN())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Bucket.Builder A fluent builder for Bucket.

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.s3.IBucket

IBucket.Jsii$Default

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addCorsRule(CorsRule rule) Adds a cross-origin access configuration for objects in an Amazon S3 bucket.
void	addInventory(Inventory inventory) Add an inventory configuration.
void	addLifecycleRule(LifecycleRule rule) Add a lifecycle rule to the bucket.
void	addMetric(BucketMetrics metric) Adds a metrics configuration for the CloudWatch request metrics from the bucket.
static IBucket	fromBucketArn(software.constructs.Construct scope, String id, String bucketArn)
static IBucket	fromBucketAttributes(software.constructs.Construct scope, String id, BucketAttributes attrs) Creates a Bucket construct that represents an external bucket.
static IBucket	fromBucketName(software.constructs.Construct scope, String id, String bucketName)
static IBucket	fromCfnBucket(CfnBucket cfnBucket) Create a mutable IBucket based on a low-level CfnBucket.
protected Boolean	getAutoCreatePolicy() Indicates if a bucket resource policy should automatically created upon the first call to `addToResourcePolicy`.
String	getBucketArn() The ARN of the bucket.
String	getBucketDomainName() The IPv4 DNS name of the specified bucket.
String	getBucketDualStackDomainName() The IPv6 DNS name of the specified bucket.
String	getBucketName() The name of the bucket.
String	getBucketRegionalDomainName() The regional domain name of the specified bucket.
String	getBucketWebsiteDomainName() The Domain name of the static website.
String	getBucketWebsiteUrl() The URL of the static website.
protected Boolean	getDisallowPublicAccess() Whether to disallow public access.
IKey	getEncryptionKey() Optional KMS encryption key associated with this bucket.
Boolean	getIsWebsite() If this bucket has been configured for static website hosting.
BucketPolicy	getPolicy() The resource policy associated with this bucket.
protected void	setAutoCreatePolicy(Boolean value) Indicates if a bucket resource policy should automatically created upon the first call to `addToResourcePolicy`.
protected void	setDisallowPublicAccess(Boolean value) Whether to disallow public access.
void	setPolicy(BucketPolicy value) The resource policy associated with this bucket.
static void	validateBucketName(String physicalName) Thrown an exception if the given bucket name is not valid.

Methods inherited from class software.amazon.awscdk.services.s3.BucketBase

addEventNotification, addObjectCreatedNotification, addObjectRemovedNotification, addToResourcePolicy, arnForObjects, enableEventBridgeNotification, getNotificationsHandlerRole, grantDelete, grantDelete, grantPublicAccess, grantPut, grantPut, grantPutAcl, grantPutAcl, grantRead, grantRead, grantReadWrite, grantReadWrite, grantWrite, grantWrite, onCloudTrailEvent, onCloudTrailEvent, onCloudTrailPutObject, onCloudTrailPutObject, onCloudTrailWriteObject, onCloudTrailWriteObject, s3UrlForObject, s3UrlForObject, setNotificationsHandlerRole, transferAccelerationUrlForObject, transferAccelerationUrlForObject, transferAccelerationUrlForObject, urlForObject, urlForObject, virtualHostedUrlForObject, virtualHostedUrlForObject, virtualHostedUrlForObject

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, 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.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Bucket

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

Bucket

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

Bucket

@Stability(value=Stable)
public Bucket(@NotNull
                                       software.constructs.Construct scope,
                                       @NotNull
                                       String id,
                                       @Nullable
                                       BucketProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

Bucket

@Stability(value=Stable)
public Bucket(@NotNull
                                       software.constructs.Construct scope,
                                       @NotNull
                                       String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

fromBucketArn

@Stability(value=Stable)
 @NotNull
public static IBucket fromBucketArn(@NotNull
                                                                       software.constructs.Construct scope,
                                                                       @NotNull
                                                                       String id,
                                                                       @NotNull
                                                                       String bucketArn)

Parameters:

scope - This parameter is required.

id - This parameter is required.

bucketArn - This parameter is required.

fromBucketAttributes

@Stability(value=Stable)
 @NotNull
public static IBucket fromBucketAttributes(@NotNull
                                                                              software.constructs.Construct scope,
                                                                              @NotNull
                                                                              String id,
                                                                              @NotNull
                                                                              BucketAttributes attrs)

Creates a Bucket construct that represents an external bucket.

Parameters:

scope - The parent creating construct (usually `this`). This parameter is required.

id - The construct's name. This parameter is required.

attrs - A `BucketAttributes` object. This parameter is required.

fromBucketName

@Stability(value=Stable)
 @NotNull
public static IBucket fromBucketName(@NotNull
                                                                        software.constructs.Construct scope,
                                                                        @NotNull
                                                                        String id,
                                                                        @NotNull
                                                                        String bucketName)

Parameters:

scope - This parameter is required.

id - This parameter is required.

bucketName - This parameter is required.

fromCfnBucket

@Stability(value=Stable)
 @NotNull
public static IBucket fromCfnBucket(@NotNull
                                                                       CfnBucket cfnBucket)

Create a mutable IBucket based on a low-level CfnBucket.

Parameters:

cfnBucket - This parameter is required.

validateBucketName

@Stability(value=Stable)
public static void validateBucketName(@NotNull
                                                               String physicalName)

Thrown an exception if the given bucket name is not valid.

Parameters:

physicalName - name of the bucket. This parameter is required.

addCorsRule

@Stability(value=Stable)
public void addCorsRule(@NotNull
                                                 CorsRule rule)

Adds a cross-origin access configuration for objects in an Amazon S3 bucket.

Parameters:

rule - The CORS configuration rule to add. This parameter is required.

addInventory

@Stability(value=Stable)
public void addInventory(@NotNull
                                                  Inventory inventory)

Add an inventory configuration.

Parameters:

inventory - configuration to add. This parameter is required.

addLifecycleRule

@Stability(value=Stable)
public void addLifecycleRule(@NotNull
                                                      LifecycleRule rule)

Add a lifecycle rule to the bucket.

Parameters:

rule - The rule to add. This parameter is required.

addMetric

@Stability(value=Stable)
public void addMetric(@NotNull
                                               BucketMetrics metric)

Adds a metrics configuration for the CloudWatch request metrics from the bucket.

Parameters:

metric - The metric configuration to add. This parameter is required.

getBucketArn

@Stability(value=Stable)
 @NotNull
public String getBucketArn()

The ARN of the bucket.

Specified by:

getBucketArn in interface IBucket

Specified by:

getBucketArn in class BucketBase

getBucketDomainName

@Stability(value=Stable)
 @NotNull
public String getBucketDomainName()

The IPv4 DNS name of the specified bucket.

Specified by:

getBucketDomainName in interface IBucket

Specified by:

getBucketDomainName in class BucketBase

getBucketDualStackDomainName

@Stability(value=Stable)
 @NotNull
public String getBucketDualStackDomainName()

The IPv6 DNS name of the specified bucket.

Specified by:

getBucketDualStackDomainName in interface IBucket

Specified by:

getBucketDualStackDomainName in class BucketBase

getBucketName

@Stability(value=Stable)
 @NotNull
public String getBucketName()

The name of the bucket.

Specified by:

getBucketName in interface IBucket

Specified by:

getBucketName in class BucketBase

getBucketRegionalDomainName

@Stability(value=Stable)
 @NotNull
public String getBucketRegionalDomainName()

The regional domain name of the specified bucket.

Specified by:

getBucketRegionalDomainName in interface IBucket

Specified by:

getBucketRegionalDomainName in class BucketBase

getBucketWebsiteDomainName

@Stability(value=Stable)
 @NotNull
public String getBucketWebsiteDomainName()

The Domain name of the static website.

Specified by:

getBucketWebsiteDomainName in interface IBucket

Specified by:

getBucketWebsiteDomainName in class BucketBase

getBucketWebsiteUrl

@Stability(value=Stable)
 @NotNull
public String getBucketWebsiteUrl()

The URL of the static website.

Specified by:

getBucketWebsiteUrl in interface IBucket

Specified by:

getBucketWebsiteUrl in class BucketBase

getEncryptionKey

@Stability(value=Stable)
 @Nullable
public IKey getEncryptionKey()

Optional KMS encryption key associated with this bucket.

Specified by:

getEncryptionKey in interface IBucket

Specified by:

getEncryptionKey in class BucketBase

getIsWebsite

@Stability(value=Stable)
 @Nullable
public Boolean getIsWebsite()

If this bucket has been configured for static website hosting.

Specified by:

getIsWebsite in interface IBucket

Specified by:

getIsWebsite in class BucketBase

getAutoCreatePolicy

@Stability(value=Stable)
 @NotNull
protected Boolean getAutoCreatePolicy()

Indicates if a bucket resource policy should automatically created upon the first call to `addToResourcePolicy`.

Specified by:

getAutoCreatePolicy in class BucketBase

setAutoCreatePolicy

@Stability(value=Stable)
protected void setAutoCreatePolicy(@NotNull
                                                            Boolean value)

Indicates if a bucket resource policy should automatically created upon the first call to `addToResourcePolicy`.

Specified by:

setAutoCreatePolicy in class BucketBase

getDisallowPublicAccess

@Stability(value=Stable)
 @Nullable
protected Boolean getDisallowPublicAccess()

Whether to disallow public access.

Specified by:

getDisallowPublicAccess in class BucketBase

setDisallowPublicAccess

@Stability(value=Stable)
protected void setDisallowPublicAccess(@Nullable
                                                                Boolean value)

Whether to disallow public access.

Specified by:

setDisallowPublicAccess in class BucketBase

getPolicy

@Stability(value=Stable)
 @Nullable
public BucketPolicy getPolicy()

The resource policy associated with this bucket.

If autoCreatePolicy is true, a BucketPolicy will be created upon the first call to addToResourcePolicy(s).

Specified by:

getPolicy in interface IBucket

Specified by:

getPolicy in class BucketBase

setPolicy

@Stability(value=Stable)
public void setPolicy(@Nullable
                                               BucketPolicy value)

The resource policy associated with this bucket.

If autoCreatePolicy is true, a BucketPolicy will be created upon the first call to addToResourcePolicy(s).

Specified by:

setPolicy in interface IBucket

Specified by:

setPolicy in class BucketBase