Package software.amazon.awscdk.services.s3

Class BucketAttributes.Builder

java.lang.Object

software.amazon.awscdk.services.s3.BucketAttributes.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<BucketAttributes>

Enclosing interface:

BucketAttributes

@Stability(Stable)
public static final class BucketAttributes.Builder
extends Object
implements software.amazon.jsii.Builder<BucketAttributes>

A builder for BucketAttributes

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
BucketAttributes.Builder	account(String account)	Sets the value of BucketAttributes.getAccount()
BucketAttributes.Builder	bucketArn(String bucketArn)	Sets the value of BucketAttributes.getBucketArn()
BucketAttributes.Builder	bucketDomainName(String bucketDomainName)	Sets the value of BucketAttributes.getBucketDomainName()
BucketAttributes.Builder	bucketDualStackDomainName(String bucketDualStackDomainName)	Sets the value of BucketAttributes.getBucketDualStackDomainName()
BucketAttributes.Builder	bucketName(String bucketName)	Sets the value of BucketAttributes.getBucketName()
BucketAttributes.Builder	bucketRegionalDomainName(String bucketRegionalDomainName)	Sets the value of BucketAttributes.getBucketRegionalDomainName()
BucketAttributes.Builder	bucketWebsiteNewUrlFormat(Boolean bucketWebsiteNewUrlFormat)	Deprecated. The correct website url format can be inferred automatically from the bucket `region`.
BucketAttributes.Builder	bucketWebsiteUrl(String bucketWebsiteUrl)	Sets the value of BucketAttributes.getBucketWebsiteUrl()
BucketAttributes	build()	Builds the configured instance.
BucketAttributes.Builder	encryptionKey(IKey encryptionKey)	Sets the value of BucketAttributes.getEncryptionKey()
BucketAttributes.Builder	isWebsite(Boolean isWebsite)	Sets the value of BucketAttributes.getIsWebsite()
BucketAttributes.Builder	notificationsHandlerRole(IRole notificationsHandlerRole)	Sets the value of BucketAttributes.getNotificationsHandlerRole()
BucketAttributes.Builder	region(String region)	Sets the value of BucketAttributes.getRegion()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

account

@Stability(Stable)
public BucketAttributes.Builder account(String account)

Sets the value of BucketAttributes.getAccount()

Parameters:

account - The account this existing bucket belongs to.

Returns:

this

bucketArn

@Stability(Stable)
public BucketAttributes.Builder bucketArn(String bucketArn)

Sets the value of BucketAttributes.getBucketArn()

Parameters:

bucketArn - The ARN of the bucket. At least one of bucketArn or bucketName must be defined in order to initialize a bucket ref.

Returns:

this

bucketDomainName

@Stability(Stable)
public BucketAttributes.Builder bucketDomainName(String bucketDomainName)

Sets the value of BucketAttributes.getBucketDomainName()

Parameters:

bucketDomainName - The domain name of the bucket.

Returns:

this

bucketDualStackDomainName

@Stability(Stable)
public BucketAttributes.Builder bucketDualStackDomainName(String bucketDualStackDomainName)

Sets the value of BucketAttributes.getBucketDualStackDomainName()

Parameters:

bucketDualStackDomainName - The IPv6 DNS name of the specified bucket.

Returns:

this

bucketName

@Stability(Stable)
public BucketAttributes.Builder bucketName(String bucketName)

Sets the value of BucketAttributes.getBucketName()

Parameters:

bucketName - The name of the bucket. If the underlying value of ARN is a string, the name will be parsed from the ARN. Otherwise, the name is optional, but some features that require the bucket name such as auto-creating a bucket policy, won't work.

Returns:

this

bucketRegionalDomainName

@Stability(Stable)
public BucketAttributes.Builder bucketRegionalDomainName(String bucketRegionalDomainName)

Sets the value of BucketAttributes.getBucketRegionalDomainName()

Parameters:

bucketRegionalDomainName - The regional domain name of the specified bucket.

Returns:

this

bucketWebsiteNewUrlFormat

@Stability(Deprecated)
@Deprecated
public BucketAttributes.Builder bucketWebsiteNewUrlFormat(Boolean bucketWebsiteNewUrlFormat)

Deprecated.

The correct website url format can be inferred automatically from the bucket `region`. Always provide the bucket region if the `bucketWebsiteUrl` will be used. Alternatively provide the full `bucketWebsiteUrl` manually.

Sets the value of BucketAttributes.getBucketWebsiteNewUrlFormat()

Parameters:

bucketWebsiteNewUrlFormat - Force the format of the website URL of the bucket. This should be true for regions launched since 2014.

Returns:

this

bucketWebsiteUrl

@Stability(Stable)
public BucketAttributes.Builder bucketWebsiteUrl(String bucketWebsiteUrl)

Sets the value of BucketAttributes.getBucketWebsiteUrl()

Parameters:

bucketWebsiteUrl - The website URL of the bucket (if static web hosting is enabled).

Returns:

this

encryptionKey

@Stability(Stable)
public BucketAttributes.Builder encryptionKey(IKey encryptionKey)

Sets the value of BucketAttributes.getEncryptionKey()

Parameters:

encryptionKey - KMS encryption key associated with this bucket.

Returns:

this

isWebsite

@Stability(Stable)
public BucketAttributes.Builder isWebsite(Boolean isWebsite)

Sets the value of BucketAttributes.getIsWebsite()

Parameters:

isWebsite - If this bucket has been configured for static website hosting.

Returns:

this

notificationsHandlerRole

@Stability(Stable)
public BucketAttributes.Builder notificationsHandlerRole(IRole notificationsHandlerRole)

Sets the value of BucketAttributes.getNotificationsHandlerRole()

Parameters:

notificationsHandlerRole - The role to be used by the notifications handler.

Returns:

this

region

@Stability(Stable)
public BucketAttributes.Builder region(String region)

Sets the value of BucketAttributes.getRegion()

Parameters:

region - The region this existing bucket is in. Features that require the region (e.g. bucketWebsiteUrl) won't fully work if the region cannot be correctly inferred.

Returns:

this

build

@Stability(Stable)
public BucketAttributes build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<BucketAttributes>

Returns:

a new instance of BucketAttributes

Throws:

NullPointerException - if any required attribute was not provided