@aws-sdk/config-resolver

What is @aws-sdk/config-resolver?

@aws-sdk/config-resolver is a package within the AWS SDK for JavaScript that provides utilities for resolving configuration settings for AWS clients. It helps in managing and resolving configurations such as region, credentials, and other client-specific settings.

What are @aws-sdk/config-resolver's main functionalities?

Region Resolution

This feature allows you to resolve the region configuration for an AWS client. The code sample demonstrates how to use the `resolveRegionConfig` function to resolve the region setting from a client configuration object.

const { resolveRegionConfig } = require('@aws-sdk/config-resolver');
const clientConfig = { region: 'us-west-2' };
const resolvedConfig = resolveRegionConfig(clientConfig);
console.log(resolvedConfig);

Credentials Resolution

This feature allows you to resolve the credentials configuration for an AWS client. The code sample demonstrates how to use the `resolveCredentialsConfig` function to resolve the credentials setting from a client configuration object.

const { resolveCredentialsConfig } = require('@aws-sdk/config-resolver');
const clientConfig = { credentials: { accessKeyId: 'AKIA...', secretAccessKey: 'SECRET...' } };
const resolvedConfig = resolveCredentialsConfig(clientConfig);
console.log(resolvedConfig);

Endpoint Resolution

This feature allows you to resolve the endpoint configuration for an AWS client. The code sample demonstrates how to use the `resolveEndpointConfig` function to resolve the endpoint setting from a client configuration object.

const { resolveEndpointConfig } = require('@aws-sdk/config-resolver');
const clientConfig = { endpoint: 'https://dynamodb.us-west-2.amazonaws.com' };
const resolvedConfig = resolveEndpointConfig(clientConfig);
console.log(resolvedConfig);

Other packages similar to @aws-sdk/config-resolver

aws-sdk

The `aws-sdk` package is the official AWS SDK for JavaScript. It provides a comprehensive set of tools for interacting with AWS services, including configuration management. Unlike `@aws-sdk/config-resolver`, which is a modular package focused on configuration resolution, `aws-sdk` is a monolithic package that includes all AWS service clients and utilities.

aws-sdk-mock

The `aws-sdk-mock` package is used for mocking AWS SDK calls in unit tests. While it does not directly compete with `@aws-sdk/config-resolver`, it provides functionalities for testing AWS SDK configurations and responses, which can be useful in a development environment where configuration resolution needs to be tested.

aws-config

The `aws-config` package is a lightweight utility for loading AWS configuration settings from various sources such as environment variables, JSON files, and command-line arguments. It offers similar configuration resolution capabilities but is more focused on loading configurations from different sources rather than resolving them for AWS clients.

README

@aws-sdk/config-resolver

An internal package

Usage

You probably shouldn't, at least directly.

Changelog

3.18.0 (2021-06-04)

Bug Fixes

• client-sts: allow overwriting default role assumer http handler (#2426) (7985995)

Features

• clients: update clients as of 06/03/2021 (#2464) (14e8fbf)
• support Sigv4 for non AWS services (#2385) (0a251aa), closes /github.com/awslabs/smithy/blob/main/smithy-aws-protocol-tests/model/restJson1/main.smithy#L11-L13
• clients: add retryModeProvider in runtimeConfig (#2440) (fc0a5da)
• codegen: add user agent for non AWS clients (#2415) (6d1a555)
• middleware-retry: add Adaptive Retry Strategy (#2454) (0c9a143)
• middleware-retry: add client side rate limiter for adaptive mode (#2439) (8ef104d)
• middleware-retry: call retry strategy based on value in retryMode (#2456) (095b990)