AWS.Config — AWS SDK for JavaScript (original) (raw)

Property Details

acm ⇒ AWS.Config, map

Returns Service-specific configuration options for AWS.ACM.

amp ⇒ AWS.Config, map

Returns Service-specific configuration options for AWS.Amp.

cognitoidentityserviceprovider ⇒ AWS.Config, map

computeChecksums ⇒ Boolean

Returns whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 and SQS only).

convertResponseTypes ⇒ Boolean

Returns whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

correctClockSkew ⇒ Boolean

Returns whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults tofalse.

credentials ⇒ AWS.Credentials

Returns the AWS credentials to sign requests with.

cur ⇒ AWS.Config, map

Returns Service-specific configuration options for AWS.CUR.

dax ⇒ AWS.Config, map

Returns Service-specific configuration options for AWS.DAX.

dlm ⇒ AWS.Config, map

Returns Service-specific configuration options for AWS.DLM.

dms ⇒ AWS.Config, map

Returns Service-specific configuration options for AWS.DMS.

drs ⇒ AWS.Config, map

Returns Service-specific configuration options for AWS.Drs.

ebs ⇒ AWS.Config, map

Returns Service-specific configuration options for AWS.EBS.

ec2 ⇒ AWS.Config, map

Returns Service-specific configuration options for AWS.EC2.

ecr ⇒ AWS.Config, map

Returns Service-specific configuration options for AWS.ECR.

ecs ⇒ AWS.Config, map

Returns Service-specific configuration options for AWS.ECS.

efs ⇒ AWS.Config, map

Returns Service-specific configuration options for AWS.EFS.

eks ⇒ AWS.Config, map

Returns Service-specific configuration options for AWS.EKS.

elb ⇒ AWS.Config, map

Returns Service-specific configuration options for AWS.ELB.

emr ⇒ AWS.Config, map

Returns Service-specific configuration options for AWS.EMR.

endpointCacheSize ⇒ Number

Returns the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000.

endpointDiscoveryEnabled ⇒ Boolean|undefined

Returns whether to call operations with endpoints given by service dynamically. Setting this config to true will enable endpoint discovery for all applicable operations. Setting it to falsewill explicitly disable endpoint discovery even though operations that require endpoint discovery will presumably fail. Leaving it toundefined means SDK only do endpoint discovery when it's required. Defaults to undefined.

es ⇒ AWS.Config, map

Returns Service-specific configuration options for AWS.ES.

fis ⇒ AWS.Config, map

Returns Service-specific configuration options for AWS.Fis.

fms ⇒ AWS.Config, map

Returns Service-specific configuration options for AWS.FMS.

fsx ⇒ AWS.Config, map

Returns Service-specific configuration options for AWS.FSx.

hostPrefixEnabled ⇒ Boolean

Returns whether to marshal request parameters to the prefix of hostname. Defaults to true.

httpOptions ⇒ map

Returns A set of options to pass to the low-level HTTP request. Currently supported options are:

proxy [String] — the URL to proxy requests through
agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only supported in the Node.js environment.
connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server afterconnectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
timeout [Integer] — The number of milliseconds a request can take before automatically being terminated. Defaults to two minutes (120000).
xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.

iam ⇒ AWS.Config, map

Returns Service-specific configuration options for AWS.IAM.

iot ⇒ AWS.Config, map

Returns Service-specific configuration options for AWS.Iot.

ivs ⇒ AWS.Config, map

Returns Service-specific configuration options for AWS.IVS.

kinesisvideosignalingchannels ⇒ AWS.Config, map

kms ⇒ AWS.Config, map

Returns Service-specific configuration options for AWS.KMS.

licensemanagerlinuxsubscriptions ⇒ AWS.Config, map

licensemanagerusersubscriptions ⇒ AWS.Config, map

logger ⇒ #write, #log

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

m2 ⇒ AWS.Config, map

Returns Service-specific configuration options for AWS.M2.

marketplacecommerceanalytics ⇒ AWS.Config, map

marketplaceentitlementservice ⇒ AWS.Config, map

maxRedirects ⇒ Integer

Returns the maximum amount of redirects to follow for a service request. Defaults to 10.

maxRetries ⇒ Integer

Returns the maximum amount of retries to perform for a service request. By default this value is calculated by the specific service object that the request is being made to.

mgn ⇒ AWS.Config, map

Returns Service-specific configuration options for AWS.Mgn.

mq ⇒ AWS.Config, map

Returns Service-specific configuration options for AWS.MQ.

oam ⇒ AWS.Config, map

Returns Service-specific configuration options for AWS.OAM.

paramValidation ⇒ Boolean|map

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 [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
max [Boolean] — Validates that a value meets the max constraint.
pattern [Boolean] — Validates that a string value matches a regular expression.
enum [Boolean] — Validates that a string value matches one of the allowable enum values.

pcs ⇒ AWS.Config, map

Returns Service-specific configuration options for AWS.PCS.

pi ⇒ AWS.Config, map

Returns Service-specific configuration options for AWS.PI.

ram ⇒ AWS.Config, map

Returns Service-specific configuration options for AWS.RAM.

rds ⇒ AWS.Config, map

Returns Service-specific configuration options for AWS.RDS.

region ⇒ AWS.Credentials

Returns The region to send service requests to.

retryDelayOptions ⇒ map

Returns A set of options to configure the retry delay on retryable errors. Currently supported options are:

base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.

route53recoverycontrolconfig ⇒ AWS.Config, map

rum ⇒ AWS.Config, map

Returns Service-specific configuration options for AWS.RUM.

s3 ⇒ AWS.Config, map

Returns Service-specific configuration options for AWS.S3.

s3BucketEndpoint ⇒ Boolean

Note:

Setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

Returns whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint).

s3DisableBodySigning ⇒ Boolean

Returns whether to disable S3 body signing when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

s3ForcePathStyle ⇒ Boolean

Returns whether to force path style URLs for S3 objects.

s3UseArnRegion ⇒ Boolean

Returns whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true.

s3UsEast1RegionalEndpoint ⇒ 'legacy'|'regional'

Returns when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client; Defaults to 'legacy'.

sagemakerfeaturestoreruntime ⇒ AWS.Config, map

serverlessapplicationrepository ⇒ AWS.Config, map

ses ⇒ AWS.Config, map

Returns Service-specific configuration options for AWS.SES.

signatureCache ⇒ Boolean

Returns whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

signatureVersion ⇒ String

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

sms ⇒ AWS.Config, map

Returns Service-specific configuration options for AWS.SMS.

sns ⇒ AWS.Config, map

Returns Service-specific configuration options for AWS.SNS.

sqs ⇒ AWS.Config, map

Returns Service-specific configuration options for AWS.SQS.

sslEnabled ⇒ Boolean

Returns whether SSL is enabled for requests.

ssm ⇒ AWS.Config, map

Returns Service-specific configuration options for AWS.SSM.

sso ⇒ AWS.Config, map

Returns Service-specific configuration options for AWS.SSO.

sts ⇒ AWS.Config, map

Returns Service-specific configuration options for AWS.STS.

stsRegionalEndpoints ⇒ 'legacy'|'regional'

Returns whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

swf ⇒ AWS.Config, map

Returns Service-specific configuration options for AWS.SWF.

systemClockOffset ⇒ Number

Returns an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

Returns Service-specific configuration options for AWS.Textract.

tnb ⇒ AWS.Config, map

Returns Service-specific configuration options for AWS.Tnb.

useAccelerateEndpoint ⇒ Boolean

Note:

This configuration option is only compatible with S3 while accessing dns-compatible buckets.

Returns Whether to use the Accelerate endpoint with the S3 service. Defaults to false.

useDualstackEndpoint ⇒ Boolean

Returns Enables IPv6 dualstack endpoint. Defaults to false.

useFipsEndpoint ⇒ Boolean

Returns Enables FIPS compatible endpoints. Defaults to false.

waf ⇒ AWS.Config, map

Returns Service-specific configuration options for AWS.WAF.

Method Details

getCredentials(callback) ⇒ void

Note:

If you configure the SDK with static or environment credentials, the credential data should already be present in credentials attribute. This method is primarily necessary to load credentials from asynchronous sources, or sources that can refresh credentials periodically.

Loads credentials from the configuration object. This is used internally by the SDK to ensure that refreshable AWS.Credentials objects are properly refreshed and loaded when sending a request. If you want to ensure that your credentials are loaded prior to a request, you can use this method directly to provide accurate credential data stored in the object.

getPromisesDependency() ⇒ void

Gets the promise dependency set by AWS.config.setPromisesDependency.

getToken(callback) ⇒ void

Note:

If you configure the SDK with static token, the token data should already be present in AWS.Config.token attribute. This method is primarily necessary to load token from asynchronous sources, or sources that can refresh token periodically.

Loads token from the configuration object. This is used internally by the SDK to ensure that refreshable AWS.Token objects are properly refreshed and loaded when sending a request. If you want to ensure that your token is loaded prior to a request, you can use this method directly to provide accurate token data stored in the object.

loadFromPath(path) ⇒ AWS.Config

Note:

Loading configuration will reset all existing configuration on the object.

Note:

This feature is not supported in the browser environment of the SDK.

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

setPromisesDependency(dep) ⇒ void

Sets the promise dependency the SDK will use wherever Promises are returned. Passing null will force the SDK to use native Promises if they are available. If native Promises are not available, passing null will have no effect.