Package io.quarkus.amazon.common.runtime

Interface SdkConfig

public interface SdkConfig
AWS SDK specific configurations

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    SdkConfig.Advanced
     

  • Method Summary

    Modifier and Type
    Method
    Description
    SdkConfig.Advanced
    advanced()
    sdk client advanced options
    @WithConverter(io.quarkus.runtime.configuration.DurationConverter.class) Optional<Duration>
    apiCallAttemptTimeout()
    The amount of time to wait for the HTTP request to complete before giving up and timing out.
    @WithConverter(io.quarkus.runtime.configuration.DurationConverter.class) Optional<Duration>
    apiCallTimeout()
    The amount of time to allow the client to complete the execution of an API call.
    Optional<URI>
    endpointOverride()
    The endpoint URI with which the SDK should communicate.

  • Method Details

    • endpointOverride

      Optional<URI> endpointOverride()
      The endpoint URI with which the SDK should communicate.

      If not specified, an appropriate endpoint to be used for the given service and region.

    • apiCallTimeout

      @WithConverter(io.quarkus.runtime.configuration.DurationConverter.class) @WithConverter(io.quarkus.runtime.configuration.DurationConverter.class) Optional<Duration> apiCallTimeout()
      The amount of time to allow the client to complete the execution of an API call.

      This timeout covers the entire client execution except for marshalling. This includes request handler execution, all HTTP requests including retries, unmarshalling, etc.

      This value should always be positive, if present.

      See Also:
      • ClientOverrideConfiguration.apiCallTimeout()

    • apiCallAttemptTimeout

      @WithConverter(io.quarkus.runtime.configuration.DurationConverter.class) @WithConverter(io.quarkus.runtime.configuration.DurationConverter.class) Optional<Duration> apiCallAttemptTimeout()
      The amount of time to wait for the HTTP request to complete before giving up and timing out.

      This value should always be positive, if present.

      See Also:
      • ClientOverrideConfiguration.apiCallAttemptTimeout()

    • advanced

      SdkConfig.Advanced advanced()
      sdk client advanced options