Class/Object

io.scalajs.npm.aws.s3

ClientConfiguration

Related Docs: object ClientConfiguration | package s3

Permalink

class ClientConfiguration extends ConfigBase

AWS.S3.ClientConfiguration

Annotations
@ScalaJSDefined() @RawJSType()
Linear Supertypes
ConfigBase, ConfigurationOptions, Object, Any, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ClientConfiguration
  2. ConfigBase
  3. ConfigurationOptions
  4. Object
  5. Any
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ClientConfiguration()

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. var apiVersion: UndefOr[String]

    Permalink

    the given AWS API Version (e.g.

    the given AWS API Version (e.g. "2006-03-01")

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. var computeChecksums: UndefOr[Boolean]

    Permalink

    Whether to compute checksums for payload bodies when the service accepts it.

    Whether to compute checksums for payload bodies when the service accepts it. Currently supported in S3 only.

    Definition Classes
    ConfigurationOptions
  8. var convertResponseTypes: UndefOr[Boolean]

    Permalink

    Whether types are converted when parsing response data.

    Whether types are converted when parsing response data.

    Definition Classes
    ConfigurationOptions
  9. var correctClockSkew: UndefOr[Boolean]

    Permalink

    Whether to apply a clock skew correction and retry requests that fail because of an skewed client clock.

    Whether to apply a clock skew correction and retry requests that fail because of an skewed client clock.

    Definition Classes
    ConfigurationOptions
  10. var credentialProvider: UndefOr[CredentialProviderChain]

    Permalink

    The provider chain used to resolve credentials if no static credentials property is set.

    The provider chain used to resolve credentials if no static credentials property is set.

    Definition Classes
    ConfigurationOptions
  11. var credentials: UndefOr[|[Credentials, CredentialsOptions]]

    Permalink

    The AWS credentials to sign requests with.

    The AWS credentials to sign requests with.

    Definition Classes
    ConfigurationOptions
  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  16. def getCredentials(callback: (AWSError) ⇒ Any): Unit

    Permalink

    Loads credentials from the configuration object.

    Loads credentials from the configuration object.

    Definition Classes
    ConfigBase
  17. def getPromisesDependency(): Function

    Permalink

    Gets the promise dependency the SDK will use wherever Promises are returned.

    Gets the promise dependency the SDK will use wherever Promises are returned.

    Definition Classes
    ConfigBase
  18. def hasOwnProperty(v: String): Boolean

    Permalink
    Definition Classes
    Object
  19. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  20. var httpOptions: UndefOr[HTTPOptions]

    Permalink

    A set of options to pass to the low-level HTTP request.

    A set of options to pass to the low-level HTTP request.

    Definition Classes
    ConfigurationOptions
  21. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  22. def isPrototypeOf(v: Object): Boolean

    Permalink
    Definition Classes
    Object
  23. def loadFromPath(path: String): ConfigBase

    Permalink

    Loads configuration data from a JSON file into this config object.

    Loads configuration data from a JSON file into this config object. Loading configuration will reset all existing configuration on the object. This feature is not supported in the browser environment of the SDK.

    path

    the path relative to your process's current working directory to load configuration from.

    Definition Classes
    ConfigBase
  24. var logger: UndefOr[Logger]

    Permalink

    An object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests.

    An object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests.

    Definition Classes
    ConfigurationOptions
  25. var maxRedirects: UndefOr[Int]

    Permalink

    The maximum amount of redirects to follow for a service request.

    The maximum amount of redirects to follow for a service request.

    Definition Classes
    ConfigurationOptions
  26. var maxRetries: UndefOr[Int]

    Permalink

    The maximum amount of retries to perform for a service request.

    The maximum amount of retries to perform for a service request.

    Definition Classes
    ConfigurationOptions
  27. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  28. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  29. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  30. val options: ConfigurationOptions

    Permalink
    Definition Classes
    ConfigBase
  31. var paramValidation: UndefOr[|[ParamValidation, Boolean]]

    Permalink

    Returns whether input parameters should be validated against the operation description before sending the request.

    Returns whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features: min|max|pattern|enum

    Definition Classes
    ConfigurationOptions
  32. def propertyIsEnumerable(v: String): Boolean

    Permalink
    Definition Classes
    Object
  33. var region: UndefOr[String]

    Permalink

    The region to send service requests to.

    The region to send service requests to.

    Definition Classes
    ConfigurationOptions
  34. var retryDelayOptions: UndefOr[RetryDelayOptions]

    Permalink

    Returns A set of options to configure the retry delay on retryable errors.

    Returns A set of options to configure the retry delay on retryable errors.

    Definition Classes
    ConfigurationOptions
  35. var s3BucketEndpoint: UndefOr[Boolean]

    Permalink

    Whether the provided endpoint addresses an individual bucket.

    Whether the provided endpoint addresses an individual bucket. false if it addresses the root API endpoint.

    Definition Classes
    ConfigurationOptions
  36. var s3DisableBodySigning: UndefOr[Boolean]

    Permalink

    Whether to disable S3 body signing when using signature version v4.

    Whether to disable S3 body signing when using signature version v4.

    Definition Classes
    ConfigurationOptions
  37. var s3ForcePathStyle: UndefOr[Boolean]

    Permalink

    Whether to force path style URLs for S3 objects.

    Whether to force path style URLs for S3 objects.

    Definition Classes
    ConfigurationOptions
  38. def setPromisesDependency(dep: Function): Unit

    Permalink

    Sets the promise dependency the SDK will use wherever Promises are returned.

    Sets the promise dependency the SDK will use wherever Promises are returned.

    dep

    - (function) a reference to a Promise constructor

    Definition Classes
    ConfigBase
  39. var signatureCache: UndefOr[Boolean]

    Permalink

    Whether the signature to sign requests with (overriding the API configuration) is cached.

    Whether the signature to sign requests with (overriding the API configuration) is cached.

    Definition Classes
    ConfigurationOptions
  40. var signatureVersion: UndefOr[String]

    Permalink

    The signature version to sign requests with (overriding the API configuration).

    The signature version to sign requests with (overriding the API configuration). Possible values: 'v2'|'v3'|'v4'

    Definition Classes
    ConfigurationOptions
  41. var sslEnabled: UndefOr[Boolean]

    Permalink

    Whether SSL is enabled for requests.

    Whether SSL is enabled for requests.

    Definition Classes
    ConfigurationOptions
  42. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  43. var systemClockOffset: UndefOr[Int]

    Permalink

    An offset value in milliseconds to apply to all signing times.

    An offset value in milliseconds to apply to all signing times.

    Definition Classes
    ConfigurationOptions
  44. def toLocaleString(): String

    Permalink
    Definition Classes
    Object
  45. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  46. def update(options: |[ConfigurationOptions, RawOptions], allowUnknownKeys: Boolean = js.native): Unit

    Permalink

    Updates the current configuration object with new options.

    Updates the current configuration object with new options.

    options

    a map of option keys and values.

    allowUnknownKeys

    Whether unknown keys can be set on the configuration object.

    Definition Classes
    ConfigBase
  47. var useAccelerateEndpoint: UndefOr[Boolean]

    Permalink

    Whether to use the Accelerate endpoint with the S3 service.

    Whether to use the Accelerate endpoint with the S3 service.

    Definition Classes
    ConfigurationOptions
  48. def valueOf(): Any

    Permalink
    Definition Classes
    Object
  49. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  50. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  51. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. var accessKeyId: UndefOr[String]

    Permalink

    AWS access key ID.

    AWS access key ID.

    Definition Classes
    ConfigurationOptions
    Deprecated
  2. var secretAccessKey: UndefOr[String]

    Permalink

    AWS secret access key.

    AWS secret access key.

    Definition Classes
    ConfigurationOptions
    Deprecated
  3. var sessionToken: UndefOr[String]

    Permalink

    AWS session token.

    AWS session token.

    Definition Classes
    ConfigurationOptions
    Deprecated

Inherited from ConfigBase

Inherited from ConfigurationOptions

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped