com.amazonaws.services.s3

Class AmazonS3ClientBuilder

java.lang.Object

com.amazonaws.client.builder.AwsClientBuilder<Subclass,TypeToBuild>

com.amazonaws.client.builder.AwsSyncClientBuilder<AmazonS3ClientBuilder,AmazonS3>

com.amazonaws.services.s3.AmazonS3ClientBuilder

@NotThreadSafe
public final class AmazonS3ClientBuilder
extends AwsSyncClientBuilder<AmazonS3ClientBuilder,AmazonS3>

Fluent builder for AmazonS3. Capable of building synchronous and asynchronous clients. Use of the builder is preferred over using constructors of the client class.

Nested Class Summary

Nested classes/interfaces inherited from class com.amazonaws.client.builder.AwsClientBuilder

AwsClientBuilder.SyncBuilderParams

Method Summary

Modifier and Type	Method and Description
protected AmazonS3	build(AwsSyncClientParams clientParams) Construct a synchronous implementation of AmazonS3 using the current builder configuration.
static AmazonS3	defaultClient()
AmazonS3ClientBuilder	disableChunkedEncoding() Disables chunked encoding on clients built via the builder.
AmazonS3ClientBuilder	enableAccelerateMode() Enables accelerate mode on clients built with the builder.
AmazonS3ClientBuilder	enableDualstack() Enables dualstack mode on clients built with the builder.
AmazonS3ClientBuilder	enablePathStyleAccess() Enables path style access for clients built via this builder.
AmazonS3ClientBuilder	enablePayloadSigning() Enables payload signing for all situations on clients built via this builder.
Boolean	isAccelerateModeEnabled()
Boolean	isChunkedEncodingDisabled()
Boolean	isDualstackEnabled()
Boolean	isPathStyleAccessEnabled()
Boolean	isPayloadSigningEnabled()
void	setAccelerateModeEnabled(Boolean accelerateModeEnabled) Configures the client to use S3 accelerate endpoint for all requests.
void	setChunkedEncodingDisabled(Boolean chunkedEncodingDisabled) Configures the client to disable chunked encoding for all requests.
void	setDualstackEnabled(Boolean dualstackEnabled) Configures the client to use Amazon S3 dualstack mode for all requests.
void	setPathStyleAccessEnabled(Boolean pathStyleAccessEnabled) Configures the client to use path-style access for all requests.
void	setPayloadSigningEnabled(Boolean payloadSigningEnabled) Configures the client to sign payloads in all situations.
static AmazonS3ClientBuilder	standard()
AmazonS3ClientBuilder	withAccelerateModeEnabled(Boolean accelerateModeEnabled) Configures the client to use S3 accelerate endpoint for all requests.
AmazonS3ClientBuilder	withChunkedEncodingDisabled(Boolean chunkedEncodingDisabled) Configures the client to disable chunked encoding for all requests.
AmazonS3ClientBuilder	withDualstackEnabled(Boolean dualstackEnabled) Configures the client to use Amazon S3 dualstack mode for all requests.
AmazonS3ClientBuilder	withPathStyleAccessEnabled(Boolean pathStyleAccessEnabled) Configures the client to use path-style access for all requests.
AmazonS3ClientBuilder	withPayloadSigningEnabled(Boolean payloadSigningEnabled) Configures the client to sign payloads in all situations.

Methods inherited from class com.amazonaws.client.builder.AwsSyncClientBuilder

build

Methods inherited from class com.amazonaws.client.builder.AwsClientBuilder

getClientConfiguration, getCredentials, getMetricsCollector, getRegion, getRequestHandlers, getSubclass, getSyncClientParams, setClientConfiguration, setCredentials, setMetricsCollector, setRegion, setRequestHandlers, withClientConfiguration, withCredentials, withMetricsCollector, withRegion, withRegion, withRequestHandlers

Methods inherited from class java.lang.Object

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

Method Detail

standard

public static AmazonS3ClientBuilder standard()

Returns:

Create new instance of builder with all defaults set.

defaultClient

public static AmazonS3 defaultClient()

Returns:

Default client using the DefaultAWSCredentialsProviderChain and DefaultAwsRegionProviderChain chain

isPathStyleAccessEnabled

public Boolean isPathStyleAccessEnabled()

Returns:

The current setting for path style access configured in the builder.

setPathStyleAccessEnabled

public void setPathStyleAccessEnabled(Boolean pathStyleAccessEnabled)

Configures the client to use path-style access for all requests.

Amazon S3 supports virtual-hosted-style and path-style access in all Regions. The path-style syntax, however, requires that you use the region-specific endpoint when attempting to access a bucket.

The default behaviour is to detect which access style to use based on the configured endpoint (an IP will result in path-style access) and the bucket being accessed (some buckets are not valid DNS names). Setting this flag will result in path-style access being used for all requests.

Parameters:

pathStyleAccessEnabled - True to always use path-style access.

withPathStyleAccessEnabled

public AmazonS3ClientBuilder withPathStyleAccessEnabled(Boolean pathStyleAccessEnabled)

Configures the client to use path-style access for all requests.

Amazon S3 supports virtual-hosted-style and path-style access in all Regions. The path-style syntax, however, requires that you use the region-specific endpoint when attempting to access a bucket.

The default behaviour is to detect which access style to use based on the configured endpoint (an IP will result in path-style access) and the bucket being accessed (some buckets are not valid DNS names). Setting this flag will result in path-style access being used for all requests.

Parameters:

pathStyleAccessEnabled - True to always use path-style access.

Returns:

This object for method chaining.

enablePathStyleAccess

public AmazonS3ClientBuilder enablePathStyleAccess()

Enables path style access for clients built via this builder.

Amazon S3 supports virtual-hosted-style and path-style access in all Regions. The path-style syntax, however, requires that you use the region-specific endpoint when attempting to access a bucket.

The default behaviour is to detect which access style to use based on the configured endpoint (an IP will result in path-style access) and the bucket being accessed (some buckets are not valid DNS names). Setting this flag will result in path-style access being used for all requests.

Returns:

This object for method chaining.

isChunkedEncodingDisabled

public Boolean isChunkedEncodingDisabled()

Returns:

The current setting for chunked encoding configured in the builder.

setChunkedEncodingDisabled

public void setChunkedEncodingDisabled(Boolean chunkedEncodingDisabled)

Configures the client to disable chunked encoding for all requests.

The default behavior is to enable chunked encoding automatically for PutObjectRequest and UploadPartRequest. Setting this flag will result in disabling chunked encoding for all requests.

Note: Enabling this option has performance implications since the checksum for the payload will have to be pre-calculated before sending the data. If your payload is large this will affect the overall time required to upload an object. Using this option is recommended only if your endpoint does not implement chunked uploading.

Parameters:

chunkedEncodingDisabled - True to disable chunked encoding.

withChunkedEncodingDisabled

public AmazonS3ClientBuilder withChunkedEncodingDisabled(Boolean chunkedEncodingDisabled)

Configures the client to disable chunked encoding for all requests.

The default behavior is to enable chunked encoding automatically for PutObjectRequest and UploadPartRequest. Setting this flag will result in disabling chunked encoding for all requests.

Note: Enabling this option has performance implications since the checksum for the payload will have to be pre-calculated before sending the data. If your payload is large this will affect the overall time required to upload an object. Using this option is recommended only if your endpoint does not implement chunked uploading.

Parameters:

chunkedEncodingDisabled - True to disable chunked encoding.

Returns:

this Builder instance that can be used for method chaining

disableChunkedEncoding

public AmazonS3ClientBuilder disableChunkedEncoding()

Disables chunked encoding on clients built via the builder.

The default behavior is to enable chunked encoding automatically for PutObjectRequest and UploadPartRequest. Setting this flag will result in disabling chunked encoding for all requests.

Note: Enabling this option has performance implications since the checksum for the payload will have to be pre-calculated before sending the data. If your payload is large this will affect the overall time required to upload an object. Using this option is recommended only if your endpoint does not implement chunked uploading.

Returns:

this Builder instance that can be used for method chaining

isAccelerateModeEnabled

public Boolean isAccelerateModeEnabled()

Returns:

The current setting for accelerate mode configured in the builder.

setAccelerateModeEnabled

public void setAccelerateModeEnabled(Boolean accelerateModeEnabled)

Configures the client to use S3 accelerate endpoint for all requests.

A bucket by default cannot be accessed in accelerate mode. If you wish to do so, you need to enable the accelerate configuration for the bucket in advance. To enable accelerate mode see AmazonS3Client.setBucketAccelerateConfiguration(com.amazonaws.services.s3.model.SetBucketAccelerateConfigurationRequest).

Parameters:

accelerateModeEnabled - True to enable accelerate mode.

withAccelerateModeEnabled

public AmazonS3ClientBuilder withAccelerateModeEnabled(Boolean accelerateModeEnabled)

Configures the client to use S3 accelerate endpoint for all requests.

A bucket by default cannot be accessed in accelerate mode. If you wish to do so, you need to enable the accelerate configuration for the bucket in advance. To enable accelerate mode see AmazonS3Client.setBucketAccelerateConfiguration(com.amazonaws.services.s3.model.SetBucketAccelerateConfigurationRequest).

Parameters:

accelerateModeEnabled - True to enable accelerate mode.

Returns:

This object for method chaining.

enableAccelerateMode

public AmazonS3ClientBuilder enableAccelerateMode()

Enables accelerate mode on clients built with the builder.

A bucket by default cannot be accessed in accelerate mode. If you wish to do so, you need to enable the accelerate configuration for the bucket in advance. To enable accelerate mode see AmazonS3Client.setBucketAccelerateConfiguration(com.amazonaws.services.s3.model.SetBucketAccelerateConfigurationRequest).

Returns:

This object for method chaining.

isPayloadSigningEnabled

public Boolean isPayloadSigningEnabled()

Returns:

The current setting for payload signing configured in the builder.

setPayloadSigningEnabled

public void setPayloadSigningEnabled(Boolean payloadSigningEnabled)

Configures the client to sign payloads in all situations.

Payload signing is optional when chunked encoding is not used and requests are made against an HTTPS endpoint. Under these conditions the client will by default opt to not sign payloads to optimize performance. If this flag is set to true the client will instead always sign payloads.

Note: Payload signing can be expensive, particularly if transferring large payloads in a single chunk. Enabling this option will result in a performance penalty.

Parameters:

payloadSigningEnabled - True to explicitly enable payload signing in all situations

withPayloadSigningEnabled

public AmazonS3ClientBuilder withPayloadSigningEnabled(Boolean payloadSigningEnabled)

Configures the client to sign payloads in all situations.

Payload signing is optional when chunked encoding is not used and requests are made against an HTTPS endpoint. Under these conditions the client will by default opt to not sign payloads to optimize performance. If this flag is set to true the client will instead always sign payloads.

Note: Payload signing can be expensive, particularly if transferring large payloads in a single chunk. Enabling this option will result in a performance penalty.

Parameters:

payloadSigningEnabled - True to explicitly enable payload signing in all situations

Returns:

This object for method chaining.

enablePayloadSigning

public AmazonS3ClientBuilder enablePayloadSigning()

Enables payload signing for all situations on clients built via this builder.

Payload signing is optional when chunked encoding is not used and requests are made against an HTTPS endpoint. Under these conditions the client will by default opt to not sign payloads to optimize performance. If this flag is set to true the client will instead always sign payloads.

Note: Payload signing can be expensive, particularly if transferring large payloads in a single chunk. Enabling this option will result in a performance penalty.

Returns:

This object for method chaining.

isDualstackEnabled

public Boolean isDualstackEnabled()

Returns:

The current setting for dualstack mode configured in the builder.

setDualstackEnabled

public void setDualstackEnabled(Boolean dualstackEnabled)

Configures the client to use Amazon S3 dualstack mode for all requests.

Parameters:

dualstackEnabled - True to enable dualstack mode.

withDualstackEnabled

public AmazonS3ClientBuilder withDualstackEnabled(Boolean dualstackEnabled)

Configures the client to use Amazon S3 dualstack mode for all requests.

Parameters:

dualstackEnabled - True to enable dualstack mode.

Returns:

This object for method chaining.

enableDualstack

public AmazonS3ClientBuilder enableDualstack()

Enables dualstack mode on clients built with the builder.

Returns:

This object for method chaining.

build

protected AmazonS3 build(AwsSyncClientParams clientParams)

Construct a synchronous implementation of AmazonS3 using the current builder configuration.

Specified by:

build in class AwsSyncClientBuilder<AmazonS3ClientBuilder,AmazonS3>

Returns:

Fully configured implementation of AmazonS3.