Package software.amazon.awssdk.crt.s3

Class S3ClientOptions

  • public class S3ClientOptions
extends Object

    • Constructor Detail

      • S3ClientOptions

        public S3ClientOptions()

    • Method Detail

      • getRegion

        public String getRegion()

      • withCredentialsProvider

        public S3ClientOptions withCredentialsProvider​(CredentialsProvider credentialsProvider)
        Deprecated.
        Please use withSigningConfig(AwsSigningConfig) instead. The credentials provider will be used to create the signing Config when the client was created. Client will use `AwsSigningConfig.getDefaultS3SigningConfig(region, credentialsProvider);` to create the signing config.
        Parameters:
        credentialsProvider - provide credentials for signing.
        Returns:
        this

      • withSigningConfig

        public S3ClientOptions withSigningConfig​(AwsSigningConfig signingConfig)
        The configuration related to signing used by S3 client. `AwsSigningConfig.getDefaultS3SigningConfig(region, credentialsProvider);` can be used as helper to create the default configuration to be used for S3. If no signing config provided, the client will skip signing. In case of public object, or the http message already has a presigned URL, signing can be skipped.
        Parameters:
        signingConfig - configuration related to signing via an AWS signing process.
        Returns:
        this

      • getPartSize

        public long getPartSize()

      • withMultipartUploadThreshold

        public S3ClientOptions withMultipartUploadThreshold​(long multipartUploadThreshold)

      • getMultiPartUploadThreshold

        public long getMultiPartUploadThreshold()

      • withThroughputTargetGbps

        public S3ClientOptions withThroughputTargetGbps​(double throughputTargetGbps)

      • getThroughputTargetGbps

        public double getThroughputTargetGbps()

      • withReadBackpressureEnabled

        public S3ClientOptions withReadBackpressureEnabled​(boolean enable)
        Set whether backpressure is enabled (false by default), to prevent response data downloading faster than you can handle it.

        If false, no backpressure is applied and data will download as fast as possible.

        If true, each S3MetaRequest has a flow-control window that shrinks as response body data is downloaded (headers do not affect the window). withInitialReadWindowSize(long) determines the starting size of each S3MetaRequest's window, in bytes. Data stops downloading data whenever the window reaches zero. Increment the window to keep data flowing by calling S3MetaRequest.incrementReadWindow(long), or by returning a size from S3MetaRequestResponseHandler.onResponseBody(java.nio.ByteBuffer, long, long). Maintain a larger window to keep up a high download throughput, parts cannot download in parallel unless the window is large enough to hold multiple parts. Maintain a smaller window to limit the amount of data buffered in memory.

        WARNING: This feature is experimental. Currently, backpressure is only applied to GetObject requests which are split into multiple parts, and you may still receive some data after the window reaches zero.

        Parameters:
        enable - whether to enable or disable backpressure
        Returns:
        this

      • getReadBackpressureEnabled

        public boolean getReadBackpressureEnabled()

      • withInitialReadWindowSize

        public S3ClientOptions withInitialReadWindowSize​(long bytes)
        The starting size of each S3MetaRequest's flow-control window (if backpressure is enabled).
        Parameters:
        bytes - size in bytes
        Returns:
        this
        See Also:
        withReadBackpressureEnabled(boolean)

      • getInitialReadWindowSize

        public long getInitialReadWindowSize()

      • getEndpoint

        public String getEndpoint()

      • getTlsContext

        public TlsContext getTlsContext()

      • withMaxConnections

        public S3ClientOptions withMaxConnections​(int maxConnections)

      • getMaxConnections

        public int getMaxConnections()

      • getComputeContentMd5

        public Boolean getComputeContentMd5()

      • withConnectTimeoutMs

        public S3ClientOptions withConnectTimeoutMs​(int connectTimeoutMs)

      • getConnectTimeoutMs

        public int getConnectTimeoutMs()

      • withHttpMonitoringOptions

        public S3ClientOptions withHttpMonitoringOptions​(HttpMonitoringOptions monitoringOptions)
        Options for detecting bad HTTP connections. If the transfer throughput falls below the specified thresholds for long enough, the operation is retried on a new connection. If left unset, default values are used.
        Parameters:
        monitoringOptions - monitoring options
        Returns:
        this