software.amazon.awssdk.services.lightsail.model

Interface Bucket.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Bucket.Builder,Bucket>, SdkBuilder<Bucket.Builder,Bucket>, SdkPojo

Enclosing class:

Bucket

public static interface Bucket.Builder
extends SdkPojo, CopyableBuilder<Bucket.Builder,Bucket>

Method Summary

Modifier and Type	Method and Description
Bucket.Builder	ableToUpdateBundle(Boolean ableToUpdateBundle) Indicates whether the bundle that is currently applied to a bucket can be changed to another bundle.
Bucket.Builder	accessLogConfig(BucketAccessLogConfig accessLogConfig) An object that describes the access log configuration for the bucket.
default Bucket.Builder	accessLogConfig(Consumer<BucketAccessLogConfig.Builder> accessLogConfig) An object that describes the access log configuration for the bucket.
Bucket.Builder	accessRules(AccessRules accessRules) An object that describes the access rules of the bucket.
default Bucket.Builder	accessRules(Consumer<AccessRules.Builder> accessRules) An object that describes the access rules of the bucket.
Bucket.Builder	arn(String arn) The Amazon Resource Name (ARN) of the bucket.
Bucket.Builder	bundleId(String bundleId) The ID of the bundle currently applied to the bucket.
Bucket.Builder	createdAt(Instant createdAt) The timestamp when the distribution was created.
default Bucket.Builder	location(Consumer<ResourceLocation.Builder> location) An object that describes the location of the bucket, such as the Amazon Web Services Region and Availability Zone.
Bucket.Builder	location(ResourceLocation location) An object that describes the location of the bucket, such as the Amazon Web Services Region and Availability Zone.
Bucket.Builder	name(String name) The name of the bucket.
Bucket.Builder	objectVersioning(String objectVersioning) Indicates whether object versioning is enabled for the bucket.
Bucket.Builder	readonlyAccessAccounts(Collection<String> readonlyAccessAccounts) An array of strings that specify the Amazon Web Services account IDs that have read-only access to the bucket.
Bucket.Builder	readonlyAccessAccounts(String... readonlyAccessAccounts) An array of strings that specify the Amazon Web Services account IDs that have read-only access to the bucket.
Bucket.Builder	resourcesReceivingAccess(Collection<ResourceReceivingAccess> resourcesReceivingAccess) An array of objects that describe Lightsail instances that have access to the bucket.
Bucket.Builder	resourcesReceivingAccess(Consumer<ResourceReceivingAccess.Builder>... resourcesReceivingAccess) An array of objects that describe Lightsail instances that have access to the bucket.
Bucket.Builder	resourcesReceivingAccess(ResourceReceivingAccess... resourcesReceivingAccess) An array of objects that describe Lightsail instances that have access to the bucket.
Bucket.Builder	resourceType(String resourceType) The Lightsail resource type of the bucket (for example, Bucket).
Bucket.Builder	state(BucketState state) An object that describes the state of the bucket.
default Bucket.Builder	state(Consumer<BucketState.Builder> state) An object that describes the state of the bucket.
Bucket.Builder	supportCode(String supportCode) The support code for a bucket.
Bucket.Builder	tags(Collection<Tag> tags) The tag keys and optional values for the bucket.
Bucket.Builder	tags(Consumer<Tag.Builder>... tags) The tag keys and optional values for the bucket.
Bucket.Builder	tags(Tag... tags) The tag keys and optional values for the bucket.
Bucket.Builder	url(String url) The URL of the bucket.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

resourceType

Bucket.Builder resourceType(String resourceType)

The Lightsail resource type of the bucket (for example, Bucket).

Parameters:

resourceType - The Lightsail resource type of the bucket (for example, Bucket).

Returns:

Returns a reference to this object so that method calls can be chained together.

accessRules

Bucket.Builder accessRules(AccessRules accessRules)

An object that describes the access rules of the bucket.

Parameters:

accessRules - An object that describes the access rules of the bucket.

Returns:

Returns a reference to this object so that method calls can be chained together.

accessRules

default Bucket.Builder accessRules(Consumer<AccessRules.Builder> accessRules)

An object that describes the access rules of the bucket.

This is a convenience method that creates an instance of the AccessRules.Builder avoiding the need to create one manually via AccessRules.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to accessRules(AccessRules).

Parameters:

accessRules - a consumer that will call methods on AccessRules.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

accessRules(AccessRules)

arn

Bucket.Builder arn(String arn)

The Amazon Resource Name (ARN) of the bucket.

Parameters:

arn - The Amazon Resource Name (ARN) of the bucket.

Returns:

Returns a reference to this object so that method calls can be chained together.

bundleId

Bucket.Builder bundleId(String bundleId)

The ID of the bundle currently applied to the bucket.

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket.

Use the UpdateBucketBundle action to change the bundle of a bucket.

Parameters:

bundleId - The ID of the bundle currently applied to the bucket.

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket.

Use the UpdateBucketBundle action to change the bundle of a bucket.

Returns:

Returns a reference to this object so that method calls can be chained together.

createdAt

Bucket.Builder createdAt(Instant createdAt)

The timestamp when the distribution was created.

Parameters:

createdAt - The timestamp when the distribution was created.

Returns:

Returns a reference to this object so that method calls can be chained together.

url

Bucket.Builder url(String url)

The URL of the bucket.

Parameters:

url - The URL of the bucket.

Returns:

Returns a reference to this object so that method calls can be chained together.

location

Bucket.Builder location(ResourceLocation location)

An object that describes the location of the bucket, such as the Amazon Web Services Region and Availability Zone.

Parameters:

location - An object that describes the location of the bucket, such as the Amazon Web Services Region and Availability Zone.

Returns:

Returns a reference to this object so that method calls can be chained together.

location

default Bucket.Builder location(Consumer<ResourceLocation.Builder> location)

An object that describes the location of the bucket, such as the Amazon Web Services Region and Availability Zone.

This is a convenience method that creates an instance of the ResourceLocation.Builder avoiding the need to create one manually via ResourceLocation.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to location(ResourceLocation).

Parameters:

location - a consumer that will call methods on ResourceLocation.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

location(ResourceLocation)

name

Bucket.Builder name(String name)

The name of the bucket.

Parameters:

name - The name of the bucket.

Returns:

Returns a reference to this object so that method calls can be chained together.

supportCode

Bucket.Builder supportCode(String supportCode)

The support code for a bucket. Include this code in your email to support when you have questions about a Lightsail bucket. This code enables our support team to look up your Lightsail information more easily.

Parameters:

supportCode - The support code for a bucket. Include this code in your email to support when you have questions about a Lightsail bucket. This code enables our support team to look up your Lightsail information more easily.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

Bucket.Builder tags(Collection<Tag> tags)

The tag keys and optional values for the bucket. For more information, see Tags in Amazon Lightsail in the Amazon Lightsail Developer Guide.

Parameters:

tags - The tag keys and optional values for the bucket. For more information, see Tags in Amazon Lightsail in the Amazon Lightsail Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

Bucket.Builder tags(Tag... tags)

The tag keys and optional values for the bucket. For more information, see Tags in Amazon Lightsail in the Amazon Lightsail Developer Guide.

Parameters:

tags - The tag keys and optional values for the bucket. For more information, see Tags in Amazon Lightsail in the Amazon Lightsail Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

Bucket.Builder tags(Consumer<Tag.Builder>... tags)

The tag keys and optional values for the bucket. For more information, see Tags in Amazon Lightsail in the Amazon Lightsail Developer Guide.

This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#tags(java.util.Collection)

objectVersioning

Bucket.Builder objectVersioning(String objectVersioning)

Indicates whether object versioning is enabled for the bucket.

The following options can be configured:

• Enabled - Object versioning is enabled.

• Suspended - Object versioning was previously enabled but is currently suspended. Existing object versions are retained.

• NeverEnabled - Object versioning has never been enabled.

Parameters:

objectVersioning - Indicates whether object versioning is enabled for the bucket.

The following options can be configured:

• Enabled - Object versioning is enabled.

• Suspended - Object versioning was previously enabled but is currently suspended. Existing object versions are retained.

• NeverEnabled - Object versioning has never been enabled.

Returns:

Returns a reference to this object so that method calls can be chained together.

ableToUpdateBundle

Bucket.Builder ableToUpdateBundle(Boolean ableToUpdateBundle)

Indicates whether the bundle that is currently applied to a bucket can be changed to another bundle.

You can update a bucket's bundle only one time within a monthly Amazon Web Services billing cycle.

Use the UpdateBucketBundle action to change a bucket's bundle.

Parameters:

ableToUpdateBundle - Indicates whether the bundle that is currently applied to a bucket can be changed to another bundle.

You can update a bucket's bundle only one time within a monthly Amazon Web Services billing cycle.

Use the UpdateBucketBundle action to change a bucket's bundle.

Returns:

Returns a reference to this object so that method calls can be chained together.

readonlyAccessAccounts

Bucket.Builder readonlyAccessAccounts(Collection<String> readonlyAccessAccounts)

An array of strings that specify the Amazon Web Services account IDs that have read-only access to the bucket.

Parameters:

readonlyAccessAccounts - An array of strings that specify the Amazon Web Services account IDs that have read-only access to the bucket.

Returns:

Returns a reference to this object so that method calls can be chained together.

readonlyAccessAccounts

Bucket.Builder readonlyAccessAccounts(String... readonlyAccessAccounts)

An array of strings that specify the Amazon Web Services account IDs that have read-only access to the bucket.

Parameters:

readonlyAccessAccounts - An array of strings that specify the Amazon Web Services account IDs that have read-only access to the bucket.

Returns:

Returns a reference to this object so that method calls can be chained together.

resourcesReceivingAccess

Bucket.Builder resourcesReceivingAccess(Collection<ResourceReceivingAccess> resourcesReceivingAccess)

An array of objects that describe Lightsail instances that have access to the bucket.

Use the SetResourceAccessForBucket action to update the instances that have access to a bucket.

Parameters:

resourcesReceivingAccess - An array of objects that describe Lightsail instances that have access to the bucket.

Use the SetResourceAccessForBucket action to update the instances that have access to a bucket.

Returns:

Returns a reference to this object so that method calls can be chained together.

resourcesReceivingAccess

Bucket.Builder resourcesReceivingAccess(ResourceReceivingAccess... resourcesReceivingAccess)

An array of objects that describe Lightsail instances that have access to the bucket.

Use the SetResourceAccessForBucket action to update the instances that have access to a bucket.

Parameters:

resourcesReceivingAccess - An array of objects that describe Lightsail instances that have access to the bucket.

Use the SetResourceAccessForBucket action to update the instances that have access to a bucket.

Returns:

Returns a reference to this object so that method calls can be chained together.

resourcesReceivingAccess

Bucket.Builder resourcesReceivingAccess(Consumer<ResourceReceivingAccess.Builder>... resourcesReceivingAccess)

An array of objects that describe Lightsail instances that have access to the bucket.

Use the SetResourceAccessForBucket action to update the instances that have access to a bucket.

This is a convenience method that creates an instance of the ResourceReceivingAccess.Builder avoiding the need to create one manually via ResourceReceivingAccess.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #resourcesReceivingAccess(List).

Parameters:

resourcesReceivingAccess - a consumer that will call methods on ResourceReceivingAccess.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#resourcesReceivingAccess(java.util.Collection)

state

Bucket.Builder state(BucketState state)

An object that describes the state of the bucket.

Parameters:

state - An object that describes the state of the bucket.

Returns:

Returns a reference to this object so that method calls can be chained together.

state

default Bucket.Builder state(Consumer<BucketState.Builder> state)

An object that describes the state of the bucket.

This is a convenience method that creates an instance of the BucketState.Builder avoiding the need to create one manually via BucketState.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to state(BucketState).

Parameters:

state - a consumer that will call methods on BucketState.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

state(BucketState)

accessLogConfig

Bucket.Builder accessLogConfig(BucketAccessLogConfig accessLogConfig)

An object that describes the access log configuration for the bucket.

Parameters:

accessLogConfig - An object that describes the access log configuration for the bucket.

Returns:

Returns a reference to this object so that method calls can be chained together.

accessLogConfig

default Bucket.Builder accessLogConfig(Consumer<BucketAccessLogConfig.Builder> accessLogConfig)

An object that describes the access log configuration for the bucket.

This is a convenience method that creates an instance of the BucketAccessLogConfig.Builder avoiding the need to create one manually via BucketAccessLogConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to accessLogConfig(BucketAccessLogConfig).

Parameters:

accessLogConfig - a consumer that will call methods on BucketAccessLogConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

accessLogConfig(BucketAccessLogConfig)