Interface: SQSAdapterConfiguration
The configuration interface of SQSClient class constructor that set the region, credentials and other options.
See
Extends
SQSClientConfig
Properties
| Property | Modifier | Type | Description | Inherited from |
|---|---|---|---|---|
apiVersion? | readonly | string | Internal The API version set internally by the SDK, and is not planned to be used by customer code. | SQSClientConfig.apiVersion |
base64Decoder? | public | Decoder | Internal The function that will be used to convert a base64-encoded string to a byte array. | SQSClientConfig.base64Decoder |
base64Encoder? | public | Encoder | Internal The function that will be used to convert binary data to a base64-encoded string. | SQSClientConfig.base64Encoder |
bodyLengthChecker? | public | BodyLengthCalculator | Internal A function that can calculate the length of a request body. | SQSClientConfig.bodyLengthChecker |
cacheMiddleware? | public | boolean | Default false. When true, the client will only resolve the middleware stack once per Command class. This means modifying the middlewareStack of the command or client after requests have been made will not be recognized. Calling client.destroy() also clears this cache. Enable this only if needing the additional time saved (0-1ms per request) and not needing middleware modifications between requests. | SQSClientConfig.cacheMiddleware |
credentialDefaultProvider? | public | (input: any) => AwsCredentialIdentityProvider | Internal Default credentials provider; Not available in browser runtime. Deprecated | SQSClientConfig.credentialDefaultProvider |
credentials? | public | AwsCredentialIdentityProvider | AwsCredentialIdentity | The credentials used to sign requests. | SQSClientConfig.credentials |
customUserAgent? | public | string | UserAgent | The custom user agent header that would be appended to default one | SQSClientConfig.customUserAgent |
defaultsMode? | public | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. | SQSClientConfig.defaultsMode |
defaultUserAgentProvider? | public | Provider<UserAgent> | Internal The provider populating default tracking information to be sent with user-agent, x-amz-user-agent header | SQSClientConfig.defaultUserAgentProvider |
disableHostPrefix? | public | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. | SQSClientConfig.disableHostPrefix |
endpoint? | public | (string | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>) & (string | Provider<string> | Endpoint | Provider<...> | EndpointV2 | Provider<...>) | The fully qualified endpoint of the webservice. This is only for using a custom endpoint (for example, when using a local version of S3). Endpoint transformations such as S3 applying a bucket to the hostname are still applicable to this custom endpoint. | SQSClientConfig.endpoint |
endpointProvider? | public | (params: EndpointParameters, context?: { logger: Logger; }) => EndpointV2 | Providing a custom endpointProvider will override built-in transformations of the endpoint such as S3 adding the bucket name to the hostname, since they are part of the default endpointProvider. | SQSClientConfig.endpointProvider |
extensions? | public | RuntimeExtension[] | Optional extensions | SQSClientConfig.extensions |
httpAuthSchemeProvider? | public | SQSHttpAuthSchemeProvider | Internal Configuration of an HttpAuthSchemeProvider for a client which resolves which HttpAuthScheme to use. | SQSClientConfig.httpAuthSchemeProvider |
httpAuthSchemes? | public | HttpAuthScheme[] | Internal Configuration of HttpAuthSchemes for a client which provides default identity providers and signers per auth scheme. | SQSClientConfig.httpAuthSchemes |
logger? | public | Logger | Optional logger for logging debug/info/warn/error. | SQSClientConfig.logger |
maxAttempts? | public | number | Provider<number> | Value for how many times a request will be made at most in case of retry. | SQSClientConfig.maxAttempts |
md5? | public | false | ChecksumConstructor | HashConstructor | A constructor for a class implementing the __Checksum interface that computes MD5 hashes, or false to prevent MD5 computation. | SQSClientConfig.md5 |
profile? | public | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE. When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority. For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. | SQSClientConfig.profile |
region? | public | string | Provider<string> | The AWS region to which this client will send requests | SQSClientConfig.region |
requestHandler? | public | (NodeHttpHandlerOptions | FetchHttpHandlerOptions | Record<string, unknown> | RequestHandler<any, any, HttpHandlerOptions>) & HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. | SQSClientConfig.requestHandler |
retryMode? | public | string | Provider<string> | Specifies which retry algorithm to use. See https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-smithy-util-retry/Enum/RETRY_MODES/ | SQSClientConfig.retryMode |
retryStrategy? | public | RetryStrategy | RetryStrategyV2 | The strategy to retry the request. Using built-in exponential backoff strategy by default. | SQSClientConfig.retryStrategy |
runtime? | public | string | Internal The runtime environment. | SQSClientConfig.runtime |
serviceConfiguredEndpoint? | public | undefined | Internal This field is used internally so you should not fill any value to this field. | SQSClientConfig.serviceConfiguredEndpoint |
serviceId? | public | string | Internal Unique service identifier. | SQSClientConfig.serviceId |
sha256? | public | ChecksumConstructor | HashConstructor | Internal A constructor for a class implementing the @smithy/types#ChecksumConstructor interface that computes the SHA-256 HMAC or checksum of a string or binary buffer. | SQSClientConfig.sha256 |
signer? | public | | RequestSigner | (authScheme?: AuthScheme) => Promise<RequestSigner> | The signer to use when signing requests. | SQSClientConfig.signer |
signerConstructor? | public | (options: SignatureV4Init & SignatureV4CryptoInit) => RequestSigner | Internal The injectable SigV4-compatible signer class constructor. If not supplied, regular SignatureV4 constructor will be used. | SQSClientConfig.signerConstructor |
signingEscapePath? | public | boolean | Whether to escape request path when signing the request. | SQSClientConfig.signingEscapePath |
signingRegion? | public | string | The region where you want to sign your request against. This can be different to the region in the endpoint. | SQSClientConfig.signingRegion |
streamCollector? | public | StreamCollector | Internal A function that converts a stream into an array of bytes. | SQSClientConfig.streamCollector |
systemClockOffset? | public | number | An offset value in milliseconds to apply to all signing times. | SQSClientConfig.systemClockOffset |
tls? | public | boolean | Whether TLS is enabled for requests. Deprecated | SQSClientConfig.tls |
urlParser? | public | UrlParser | Internal The function that will be used to convert strings into HTTP endpoints. | SQSClientConfig.urlParser |
useDualstackEndpoint? | public | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. | SQSClientConfig.useDualstackEndpoint |
useFipsEndpoint? | public | boolean | Provider<boolean> | Enables FIPS compatible endpoints. | SQSClientConfig.useFipsEndpoint |
useQueueUrlAsEndpoint? | public | boolean | In cases where a QueueUrl is given as input, that will be preferred as the request endpoint. Set this value to false to ignore the QueueUrl and use the client's resolved endpoint, which may be a custom endpoint. | SQSClientConfig.useQueueUrlAsEndpoint |
userAgentAppId? | public | string | Provider<undefined | string> | The application ID used to identify the application. | SQSClientConfig.userAgentAppId |
utf8Decoder? | public | Decoder | Internal The function that will be used to convert a UTF8-encoded string to a byte array. | SQSClientConfig.utf8Decoder |
utf8Encoder? | public | Encoder | Internal The function that will be used to convert binary data to a UTF-8 encoded string. | SQSClientConfig.utf8Encoder |