Package software.amazon.awssdk.http.auth.aws.signer

Interface AwsV4FamilyHttpSigner<T extends Identity>

All Superinterfaces:

HttpSigner<T>

All Known Subinterfaces:

AwsV4aHttpSigner, AwsV4HttpSigner

All Known Implementing Classes:

DefaultAwsCrtV4aHttpSigner, DefaultAwsV4HttpSigner

public interface AwsV4FamilyHttpSigner<T extends Identity>
extends HttpSigner<T>

An interface shared by AwsV4HttpSigner and AwsV4aHttpSigner for defining signer properties that are common across both signers.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	AwsV4FamilyHttpSigner.AuthLocation	This enum represents where auth-related data is inserted, as a result of signing.

Field Summary

Fields

Modifier and Type	Field	Description
static SignerProperty<AwsV4FamilyHttpSigner.AuthLocation>	AUTH_LOCATION	The location where auth-related data is inserted, as a result of signing.
static SignerProperty<ChecksumAlgorithm>	CHECKSUM_ALGORITHM	The algorithm to use for calculating a "flexible" checksum.
static SignerProperty<Boolean>	CHUNK_ENCODING_ENABLED	Whether to indicate that a payload is chunk-encoded or not.
static SignerProperty<Boolean>	DOUBLE_URL_ENCODE	A boolean to indicate whether to double url-encode the resource path when constructing the canonical request.
static SignerProperty<Duration>	EXPIRATION_DURATION	The duration for the request to be valid.
static SignerProperty<Boolean>	NORMALIZE_PATH	A boolean to indicate whether the resource path should be "normalized" according to RFC3986 when constructing the canonical request.
static SignerProperty<Boolean>	PAYLOAD_SIGNING_ENABLED	Whether to indicate that a payload is signed or not.
static SignerProperty<String>	SERVICE_SIGNING_NAME	The name of the AWS service.

Fields inherited from interface software.amazon.awssdk.http.auth.spi.signer.HttpSigner

SIGNING_CLOCK

Method Summary

Methods inherited from interface software.amazon.awssdk.http.auth.spi.signer.HttpSigner

doNotSign, sign, sign, signAsync, signAsync

Field Detail

SERVICE_SIGNING_NAME

static final SignerProperty<String> SERVICE_SIGNING_NAME

The name of the AWS service. This property is required. This value can be found in the service documentation or on the service client itself (e.g. S3Client.SERVICE_NAME).

DOUBLE_URL_ENCODE

static final SignerProperty<Boolean> DOUBLE_URL_ENCODE

A boolean to indicate whether to double url-encode the resource path when constructing the canonical request. This property defaults to true.

Note: S3 requires this value to be set to 'false' to prevent signature mismatch errors for certain paths.

NORMALIZE_PATH

static final SignerProperty<Boolean> NORMALIZE_PATH

A boolean to indicate whether the resource path should be "normalized" according to RFC3986 when constructing the canonical request. This property defaults to true.

Note: S3 requires this value to be set to 'false' to prevent signature mismatch errors for certain paths.

AUTH_LOCATION

static final SignerProperty<AwsV4FamilyHttpSigner.AuthLocation> AUTH_LOCATION

The location where auth-related data is inserted, as a result of signing. This property defaults to HEADER.

EXPIRATION_DURATION

static final SignerProperty<Duration> EXPIRATION_DURATION

The duration for the request to be valid. This property defaults to null. This can be set to presign the request for later use. The maximum allowed value for this property is 7 days. This is only supported when AuthLocation=QUERY.

PAYLOAD_SIGNING_ENABLED

static final SignerProperty<Boolean> PAYLOAD_SIGNING_ENABLED

Whether to indicate that a payload is signed or not. This property defaults to true. This can be set false to disable payload signing.

When this value is true and CHUNK_ENCODING_ENABLED is false, the whole payload must be read to generate the payload signature. For very large payloads, this could impact memory usage and call latency. Some services support this value being disabled, especially over HTTPS where SSL provides some of its own protections against payload tampering.

CHUNK_ENCODING_ENABLED

static final SignerProperty<Boolean> CHUNK_ENCODING_ENABLED

Whether to indicate that a payload is chunk-encoded or not. This property defaults to false. This can be set true to enable the `aws-chunked` content-encoding.

Only some services support this value being set to true, but for those services it can prevent the need to read the whole payload before writing when PAYLOAD_SIGNING_ENABLED is true.

CHECKSUM_ALGORITHM

static final SignerProperty<ChecksumAlgorithm> CHECKSUM_ALGORITHM

The algorithm to use for calculating a "flexible" checksum. This property is optional.