software.amazon.awscdk.services.s3

Class Bucket

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.s3.BucketBase

software.amazon.awscdk.services.s3.Bucket

All Implemented Interfaces:

IConstruct, IDependable, IResource, IBucket

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:41.527Z")
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:

 Repository ecrRepository;
 Project.Builder.create(this, "Project")
         .environment(BuildEnvironment.builder()
                 .buildImage(WindowsBuildImage.fromEcrRepository(ecrRepository, "v1.0", WindowsImageType.SERVER_2019))
                 // optional certificate to include in the build image
                 .certificate(BuildEnvironmentCertificate.builder()
                         .bucket(Bucket.fromBucketName(this, "Bucket", "my-bucket"))
                         .objectKey("path/to/cert.pem")
                         .build())
                 .build())
         .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 interface software.amazon.awscdk.services.s3.IBucket

IBucket.Jsii$Default

Constructor Summary

Constructors

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

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, java.lang.String id, java.lang.String bucketArn)
static IBucket	fromBucketAttributes(software.constructs.Construct scope, java.lang.String id, BucketAttributes attrs) Creates a Bucket construct that represents an external bucket.
static IBucket	fromBucketName(software.constructs.Construct scope, java.lang.String id, java.lang.String bucketName)
protected java.lang.Boolean	getAutoCreatePolicy() Indicates if a bucket resource policy should automatically created upon the first call to `addToResourcePolicy`.
java.lang.String	getBucketArn() The ARN of the bucket.
java.lang.String	getBucketDomainName() The IPv4 DNS name of the specified bucket.
java.lang.String	getBucketDualStackDomainName() The IPv6 DNS name of the specified bucket.
java.lang.String	getBucketName() The name of the bucket.
java.lang.String	getBucketRegionalDomainName() The regional domain name of the specified bucket.
java.lang.String	getBucketWebsiteDomainName() The Domain name of the static website.
java.lang.String	getBucketWebsiteUrl() The URL of the static website.
protected java.lang.Boolean	getDisallowPublicAccess() Whether to disallow public access.
IKey	getEncryptionKey() Optional KMS encryption key associated with this bucket.
java.lang.Boolean	getIsWebsite() If this bucket has been configured for static website hosting.
BucketPolicy	getPolicy() The resource policy associated with this bucket.
protected void	setAutoCreatePolicy(java.lang.Boolean value) Indicates if a bucket resource policy should automatically created upon the first call to `addToResourcePolicy`.
protected void	setDisallowPublicAccess(java.lang.Boolean value) Whether to disallow public access.
void	setPolicy(BucketPolicy value) The resource policy associated with this bucket.
static void	validateBucketName(java.lang.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, validate, virtualHostedUrlForObject, virtualHostedUrlForObject, virtualHostedUrlForObject

Methods inherited from class software.amazon.awscdk.core.Resource

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

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

Bucket

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

Bucket

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

Bucket

public Bucket(software.constructs.Construct scope,
              java.lang.String id,
              BucketProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

Bucket

public Bucket(software.constructs.Construct scope,
              java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

fromBucketArn

public static IBucket fromBucketArn(software.constructs.Construct scope,
                                    java.lang.String id,
                                    java.lang.String bucketArn)

Parameters:

scope - This parameter is required.

id - This parameter is required.

bucketArn - This parameter is required.

fromBucketAttributes

public static IBucket fromBucketAttributes(software.constructs.Construct scope,
                                           java.lang.String id,
                                           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

public static IBucket fromBucketName(software.constructs.Construct scope,
                                     java.lang.String id,
                                     java.lang.String bucketName)

Parameters:

scope - This parameter is required.

id - This parameter is required.

bucketName - This parameter is required.

validateBucketName

public static void validateBucketName(java.lang.String physicalName)

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

Parameters:

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

addCorsRule

public void addCorsRule(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

public void addInventory(Inventory inventory)

Add an inventory configuration.

Parameters:

inventory - configuration to add. This parameter is required.

addLifecycleRule

public void addLifecycleRule(LifecycleRule rule)

Add a lifecycle rule to the bucket.

Parameters:

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

addMetric

public void addMetric(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

public java.lang.String getBucketArn()

The ARN of the bucket.

Specified by:

getBucketArn in interface IBucket

Specified by:

getBucketArn in class BucketBase

getBucketDomainName

public java.lang.String getBucketDomainName()

The IPv4 DNS name of the specified bucket.

Specified by:

getBucketDomainName in interface IBucket

Specified by:

getBucketDomainName in class BucketBase

getBucketDualStackDomainName

public java.lang.String getBucketDualStackDomainName()

The IPv6 DNS name of the specified bucket.

Specified by:

getBucketDualStackDomainName in interface IBucket

Specified by:

getBucketDualStackDomainName in class BucketBase

getBucketName

public java.lang.String getBucketName()

The name of the bucket.

Specified by:

getBucketName in interface IBucket

Specified by:

getBucketName in class BucketBase

getBucketRegionalDomainName

public java.lang.String getBucketRegionalDomainName()

The regional domain name of the specified bucket.

Specified by:

getBucketRegionalDomainName in interface IBucket

Specified by:

getBucketRegionalDomainName in class BucketBase

getBucketWebsiteDomainName

public java.lang.String getBucketWebsiteDomainName()

The Domain name of the static website.

Specified by:

getBucketWebsiteDomainName in interface IBucket

Specified by:

getBucketWebsiteDomainName in class BucketBase

getBucketWebsiteUrl

public java.lang.String getBucketWebsiteUrl()

The URL of the static website.

Specified by:

getBucketWebsiteUrl in interface IBucket

Specified by:

getBucketWebsiteUrl in class BucketBase

getEncryptionKey

public IKey getEncryptionKey()

Optional KMS encryption key associated with this bucket.

Specified by:

getEncryptionKey in interface IBucket

Specified by:

getEncryptionKey in class BucketBase

getIsWebsite

public java.lang.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

protected java.lang.Boolean getAutoCreatePolicy()

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

Specified by:

getAutoCreatePolicy in class BucketBase

setAutoCreatePolicy

protected void setAutoCreatePolicy(java.lang.Boolean value)

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

Specified by:

setAutoCreatePolicy in class BucketBase

getDisallowPublicAccess

protected java.lang.Boolean getDisallowPublicAccess()

Whether to disallow public access.

Specified by:

getDisallowPublicAccess in class BucketBase

setDisallowPublicAccess

protected void setDisallowPublicAccess(java.lang.Boolean value)

Whether to disallow public access.

Specified by:

setDisallowPublicAccess in class BucketBase

getPolicy

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

public void setPolicy(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