@aws-sdk/middleware-host-header

What is @aws-sdk/middleware-host-header?

The @aws-sdk/middleware-host-header npm package is part of the AWS SDK for JavaScript (v3). It is a middleware that is used for setting the host header in the request. This is particularly useful when making HTTP requests to AWS services, ensuring that the host header matches the service endpoint. This can be critical for the proper routing and handling of requests within AWS's infrastructure.

What are @aws-sdk/middleware-host-header's main functionalities?

Setting Host Header

This code demonstrates how to add the hostHeaderMiddleware to an AWS SDK client instance. In this example, an S3 client is created, and the middleware is added to automatically set the host header when sending a PutObjectCommand. This ensures that the request is properly routed to the intended AWS service endpoint.

"use strict";
const { S3Client, PutObjectCommand } = require('@aws-sdk/client-s3');
const { hostHeaderMiddleware } = require('@aws-sdk/middleware-host-header');

const client = new S3Client({});
client.middlewareStack.add(hostHeaderMiddleware(), {
  step: 'build',
  name: 'hostHeaderMiddleware',
  tags: { SET_HOST_HEADER: true },
  priority: 'high',
});

const command = new PutObjectCommand({
  Bucket: 'example-bucket',
  Key: 'example-object',
  Body: 'Hello, world!'
});

client.send(command).then((response) => {
  console.log('Success', response);
}).catch((error) => {
  console.error('Error', error);
});

Other packages similar to @aws-sdk/middleware-host-header

@aws-sdk/middleware-logger

Similar to @aws-sdk/middleware-host-header, @aws-sdk/middleware-logger is also a middleware for the AWS SDK for JavaScript (v3) but focuses on logging requests and responses. While host-header middleware ensures the correct host header is set for service requests, the logger middleware provides insights into the request lifecycle, making it easier to debug and monitor AWS SDK operations.

@aws-sdk/middleware-retry

Another middleware in the AWS SDK for JavaScript (v3), @aws-sdk/middleware-retry, provides automatic retry functionality for requests that fail due to transient errors. Unlike @aws-sdk/middleware-host-header, which ensures the correct host header, the retry middleware automatically retries requests based on predefined policies and strategies, helping to improve the robustness of applications interacting with AWS services.

README

@aws-sdk/middleware-host-header

Changelog

3.4.1 (2021-01-29)

Bug Fixes

• client-ec2: update ec2 model (#1982) (599725a)
• client-forecast:* fix API docs (#1981) (ebd7b2b)
• clients: use TS 3.4 compatible types for TS 3.9 (#1978) (8bced5c)

Features

• use git-sync action to sync with private mirror (#1965) (10ab6a1)