class ConfigBase extends ConfigurationOptions
AWS.ConfigBase
- Annotations
- @RawJSType() @native() @JSImport( "aws-sdk" , "ConfigBase" )
- Alphabetic
- By Inheritance
- ConfigBase
- ConfigurationOptions
- Object
- Any
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new ConfigBase(options: ConfigurationOptions = js.native)
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
var
computeChecksums: UndefOr[Boolean]
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
-
var
convertResponseTypes: UndefOr[Boolean]
Whether types are converted when parsing response data.
Whether types are converted when parsing response data.
- Definition Classes
- ConfigurationOptions
-
var
correctClockSkew: UndefOr[Boolean]
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
-
var
credentialProvider: UndefOr[CredentialProviderChain]
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
-
var
credentials: UndefOr[|[Credentials, CredentialsOptions]]
The AWS credentials to sign requests with.
The AWS credentials to sign requests with.
- Definition Classes
- ConfigurationOptions
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
getCredentials(callback: (AWSError) ⇒ Any): Unit
Loads credentials from the configuration object.
-
def
getPromisesDependency(): Function
Gets the promise dependency the SDK will use wherever Promises are returned.
-
def
hasOwnProperty(v: String): Boolean
- Definition Classes
- Object
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
var
httpOptions: UndefOr[HTTPOptions]
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
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
isPrototypeOf(v: Object): Boolean
- Definition Classes
- Object
-
def
loadFromPath(path: String): ConfigBase
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.
-
var
logger: UndefOr[Logger]
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
-
var
maxRedirects: UndefOr[Int]
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
-
var
maxRetries: UndefOr[Int]
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
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- val options: ConfigurationOptions
-
var
paramValidation: UndefOr[|[ParamValidation, Boolean]]
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
-
def
propertyIsEnumerable(v: String): Boolean
- Definition Classes
- Object
-
var
region: UndefOr[String]
The region to send service requests to.
The region to send service requests to.
- Definition Classes
- ConfigurationOptions
-
var
retryDelayOptions: UndefOr[RetryDelayOptions]
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
-
var
s3BucketEndpoint: UndefOr[Boolean]
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
-
var
s3DisableBodySigning: UndefOr[Boolean]
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
-
var
s3ForcePathStyle: UndefOr[Boolean]
Whether to force path style URLs for S3 objects.
Whether to force path style URLs for S3 objects.
- Definition Classes
- ConfigurationOptions
-
def
setPromisesDependency(dep: Function): Unit
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
-
var
signatureCache: UndefOr[Boolean]
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
-
var
signatureVersion: UndefOr[String]
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
-
var
sslEnabled: UndefOr[Boolean]
Whether SSL is enabled for requests.
Whether SSL is enabled for requests.
- Definition Classes
- ConfigurationOptions
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
var
systemClockOffset: UndefOr[Int]
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
-
def
toLocaleString(): String
- Definition Classes
- Object
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
def
update(options: |[ConfigurationOptions, RawOptions], allowUnknownKeys: Boolean = js.native): Unit
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.
-
var
useAccelerateEndpoint: UndefOr[Boolean]
Whether to use the Accelerate endpoint with the S3 service.
Whether to use the Accelerate endpoint with the S3 service.
- Definition Classes
- ConfigurationOptions
-
def
valueOf(): Any
- Definition Classes
- Object
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
Deprecated Value Members
-
var
accessKeyId: UndefOr[String]
AWS access key ID.
AWS access key ID.
- Definition Classes
- ConfigurationOptions
- Deprecated
-
var
secretAccessKey: UndefOr[String]
AWS secret access key.
AWS secret access key.
- Definition Classes
- ConfigurationOptions
- Deprecated
-
var
sessionToken: UndefOr[String]
AWS session token.
AWS session token.
- Definition Classes
- ConfigurationOptions
- Deprecated