software.amazon.awssdk.auth.signer.params

Interface Aws4SignerParams.Builder<B extends Aws4SignerParams.Builder<B>>

All Known Subinterfaces:

Aws4PresignerParams.Builder, AwsS3V4SignerParams.Builder

All Known Implementing Classes:

Aws4SignerParams.BuilderImpl

Enclosing class:

Aws4SignerParams

public static interface Aws4SignerParams.Builder<B extends Aws4SignerParams.Builder<B>>

Method Summary

Modifier and Type	Method and Description
B	awsCredentials(AwsCredentials awsCredentials) Sets the aws credentials to use for computing the signature.
Aws4SignerParams	build()
B	checksumParams(SignerChecksumParams checksumParams) Checksum params required to compute the Checksum while data is read for signing the Checksum.
B	doubleUrlEncode(Boolean doubleUrlEncode) Set this value to double url-encode the resource path when constructing the canonical request.
B	normalizePath(Boolean normalizePath) Whether the resource path should be "normalized" according to RFC3986 when constructing the canonical request.
B	signingClockOverride(Clock signingClockOverride) The clock to use for overriding the signing time when computing signature for a request.
B	signingName(String signingName) The name of the AWS service to be used for computing the signature.
B	signingRegion(Region signingRegion) The AWS region to be used for computing the signature.
B	timeOffset(Integer timeOffset) The time offset (for clock skew correction) to use when computing the signing date for the request.

Method Detail

doubleUrlEncode

B doubleUrlEncode(Boolean doubleUrlEncode)

Set this value to double url-encode the resource path when constructing the canonical request. By default, all services except S3 enable double url-encoding.

Parameters:

doubleUrlEncode - Set true to enable double url encoding. Otherwise false.

normalizePath

B normalizePath(Boolean normalizePath)

Whether the resource path should be "normalized" according to RFC3986 when constructing the canonical request. By default, all services except S3 enable resource path normalization.

awsCredentials

B awsCredentials(AwsCredentials awsCredentials)

Sets the aws credentials to use for computing the signature.

Parameters:

awsCredentials - Aws Credentials to use for computing the signature.

signingName

B signingName(String signingName)

The name of the AWS service to be used for computing the signature.

Parameters:

signingName - Name of the AWS service to be used for computing the signature.

signingRegion

B signingRegion(Region signingRegion)

The AWS region to be used for computing the signature.

Parameters:

signingRegion - AWS region to be used for computing the signature.

timeOffset

B timeOffset(Integer timeOffset)

The time offset (for clock skew correction) to use when computing the signing date for the request.

Parameters:

timeOffset - The time offset (for clock skew correction) to use when computing the signing date for the request.

signingClockOverride

B signingClockOverride(Clock signingClockOverride)

The clock to use for overriding the signing time when computing signature for a request. By default, current time of the system is used for signing. This parameter can be used to set custom signing time. Useful option for testing.

Parameters:

signingClockOverride - The clock to use for overriding the signing time when computing signature for a request.

checksumParams

B checksumParams(SignerChecksumParams checksumParams)

Checksum params required to compute the Checksum while data is read for signing the Checksum.

Parameters:

checksumParams - SignerChecksumParams that defines the Algorithm and headers to pass Checksum.

Returns:

build

Aws4SignerParams build()