public class S3ClientOptions
extends Object 

• 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_CHUNKED_ENCODING_DISABLED The default setting for use of chunked encoding
  static boolean	DEFAULT_DUALSTACK_ENABLED S3 dualstack endpoint is by default not enabled
  static boolean	DEFAULT_FORCE_GLOBAL_BUCKET_ACCESS_ENABLED By default, clients should be created with a region.
  static boolean	DEFAULT_PATH_STYLE_ACCESS The default setting for use of path-style access
  static boolean	DEFAULT_PAYLOAD_SIGNING_ENABLED The default setting for use of payload signing
  static boolean	DEFAULT_US_EAST_1_REGION_ENDPOINT_ENABLED By default, region us-east-1 translates to the global endpoint
  static boolean	DEFAULT_USE_ARN_REGION By default, clients will not allow a call to a different region that has been specified in an ARN

• 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

  All Methods

  Modifier and Type	Method and Description
  static S3ClientOptions.Builder	builder ()
  S3ClientOptions	disableChunkedEncoding () Deprecated. Use builder() to build new S3ClientOptions instead.
  boolean	isAccelerateModeEnabled () Returns whether the client has enabled accelerate mode for getting and putting objects.
  boolean	isChunkedEncodingDisabled () Returns whether the client has chunked encoding disabled for all requests.
  boolean	isDualstackEnabled () Returns whether the client is configured to use dualstack mode for accessing S3.
  boolean	isForceGlobalBucketAccessEnabled () Returns whether the client should be configured with global bucket access enabled.
  boolean	isPathStyleAccess () Returns whether the client uses path-style access for all requests.
  boolean	isPayloadSigningEnabled () Returns whether the client is configured to sign payloads in all situations.
  boolean	isRegionalUsEast1EndpointEnabled () Returns whether the client has enabled resolving us-east-1 to a regional endpoint.
  boolean	isUseArnRegion () Returns whether the client should be configured to allow calls to different regions specified in an ARN.
  void	setChunkedEncodingDisabled (boolean chunkedEncodingDisabled) Deprecated. Use builder() to build new S3ClientOptions instead.
  void	setPathStyleAccess (boolean pathStyleAccess) Deprecated. Use builder() to build new S3ClientOptions instead.
  S3ClientOptions	withChunkedEncodingDisabled (boolean chunkedEncodingDisabled) Deprecated. Use builder() to build new S3ClientOptions instead.
  S3ClientOptions	withPathStyleAccess (boolean pathStyleAccess) Deprecated. Use builder() to build new S3ClientOptions instead.

  • Methods inherited from class java.lang.Object

    equals, 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_CHUNKED_ENCODING_DISABLED

    public static final boolean DEFAULT_CHUNKED_ENCODING_DISABLED

    The default setting for use of chunked encoding

    See Also:

    Constant Field Values

  • DEFAULT_PAYLOAD_SIGNING_ENABLED

    public static final boolean DEFAULT_PAYLOAD_SIGNING_ENABLED

    The default setting for use of payload signing

    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

  • DEFAULT_DUALSTACK_ENABLED

    public static final boolean DEFAULT_DUALSTACK_ENABLED

    S3 dualstack endpoint is by default not enabled

    See Also:

    Constant Field Values

  • DEFAULT_FORCE_GLOBAL_BUCKET_ACCESS_ENABLED

    public static final boolean DEFAULT_FORCE_GLOBAL_BUCKET_ACCESS_ENABLED

    By default, clients should be created with a region.

    See Also:

    Constant Field Values

  • DEFAULT_USE_ARN_REGION

    public static final boolean DEFAULT_USE_ARN_REGION

    By default, clients will not allow a call to a different region that has been specified in an ARN

    See Also:

    Constant Field Values

  • DEFAULT_US_EAST_1_REGION_ENDPOINT_ENABLED

    public static final boolean DEFAULT_US_EAST_1_REGION_ENDPOINT_ENABLED

    By default, region us-east-1 translates to the global endpoint

    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

  • isChunkedEncodingDisabled

    public boolean isChunkedEncodingDisabled()

    Returns whether the client has chunked encoding disabled 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.

    Returns:

    True if chunked encoding is explicitly disabled for all requests

  • 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.

  • isPayloadSigningEnabled

    public boolean isPayloadSigningEnabled()

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

    Returns:

    True if body signing is explicitly enabled for all requests

  • isDualstackEnabled

    public boolean isDualstackEnabled()

    Returns whether the client is configured to use dualstack mode for accessing S3.

    Returns:

    True if the client will use the dualstack mode

  • isForceGlobalBucketAccessEnabled

    public boolean isForceGlobalBucketAccessEnabled()

    Returns whether the client should be configured with global bucket access enabled.

    See Also:

    S3ClientOptions.Builder.enableForceGlobalBucketAccess()

  • isUseArnRegion

    public boolean isUseArnRegion()

    Returns whether the client should be configured to allow calls to different regions specified in an ARN.

    See Also:

    S3ClientOptions.Builder.enableUseArnRegion()

  • isRegionalUsEast1EndpointEnabled

    public boolean isRegionalUsEast1EndpointEnabled()

    Returns whether the client has enabled resolving us-east-1 to a regional endpoint.

    Returns:

    True if regional endpoint translation is enabled

  • setPathStyleAccess

    @Deprecated
    public void setPathStyleAccess(boolean pathStyleAccess)

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

  • withPathStyleAccess

    @Deprecated
    public S3ClientOptions withPathStyleAccess(boolean pathStyleAccess)

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

  • setChunkedEncodingDisabled

    @Deprecated
    public void setChunkedEncodingDisabled(boolean chunkedEncodingDisabled)

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

  • withChunkedEncodingDisabled

    @Deprecated
    public S3ClientOptions withChunkedEncodingDisabled(boolean chunkedEncodingDisabled)

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

  • disableChunkedEncoding

    @Deprecated
    public S3ClientOptions disableChunkedEncoding()

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