com.amazonaws.services.s3

Class S3ClientOptions

java.lang.Object

com.amazonaws.services.s3.S3ClientOptions

public class S3ClientOptions
extends Object

S3 client configuration options such as the request access style.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	S3ClientOptions.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_ACCELERATE_MODE_ENABLED S3 accelerate is by default not enabled
static boolean	DEFAULT_PATH_STYLE_ACCESS The default setting for use of path-style access

Constructor Summary

Constructors

Constructor and Description
S3ClientOptions() Deprecated. Use builder() to build new S3ClientOptions instead.
S3ClientOptions(S3ClientOptions other) Deprecated. Will be removed once S3ClientOptions is made an immutable class.

Method Summary

Modifier and Type	Method and Description
static S3ClientOptions.Builder	builder()
boolean	isAccelerateModeEnabled() Returns whether the client has enabled accelerate mode for getting and putting objects.
boolean	isPathStyleAccess() Returns whether the client uses path-style access for all requests.
void	setPathStyleAccess(boolean pathStyleAccess) Deprecated.
S3ClientOptions	withPathStyleAccess(boolean pathStyleAccess) Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PATH_STYLE_ACCESS

public static final boolean DEFAULT_PATH_STYLE_ACCESS

The default setting for use of path-style access

See Also:

Constant Field Values

DEFAULT_ACCELERATE_MODE_ENABLED

public static final boolean DEFAULT_ACCELERATE_MODE_ENABLED

S3 accelerate is by default not enabled

See Also:

Constant Field Values

Constructor Detail

S3ClientOptions

@Deprecated
public S3ClientOptions()

Deprecated. Use builder() to build new S3ClientOptions instead.

S3ClientOptions

@Deprecated
public S3ClientOptions(S3ClientOptions other)

Deprecated. Will be removed once S3ClientOptions is made an immutable class.

Method Detail

builder

public static S3ClientOptions.Builder builder()

Returns:

a new S3ClientOptions builder.

isPathStyleAccess

public boolean isPathStyleAccess()

Returns whether the client uses 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.

Returns:

True is the client should always use path-style access

isAccelerateModeEnabled

public boolean isAccelerateModeEnabled()

Returns whether the client has enabled accelerate mode for getting and putting objects.

The default behavior is to disable accelerate mode for any operations (GET, PUT, DELETE). You need to call AmazonS3Client.setBucketAccelerateConfiguration(com.amazonaws.services.s3.model.SetBucketAccelerateConfigurationRequest) first to use this feature.

Returns:

True if accelerate mode is enabled.

setPathStyleAccess

@Deprecated
public void setPathStyleAccess(boolean pathStyleAccess)

Deprecated.

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:

pathStyleAccess - True to always use path-style access.

withPathStyleAccess

@Deprecated
public S3ClientOptions withPathStyleAccess(boolean pathStyleAccess)

Deprecated.

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:

pathStyleAccess - True to always use path-style access.

Returns:

The updated S3ClientOptions object with the new path-style access setting.