AWS rules engine authentication scheme validators#
AWS-specific rules engine library authentication scheme validators make it possible to validate configurations for AWS authentication schemes like AWS signature version 4 and AWS signature version 4a. An additional dependency is required to access these validators.
The following example adds smithy-aws-endpoints
as a dependency to a Smithy project:
smithy-build.json#
{
"maven": {
"dependencies": [
"software.amazon.smithy:smithy-aws-endpoints:1.54.0"
]
}
}
sigv4
authentication scheme validator#
- Requirement
- The
name
property is the string valuesigv4
. - Properties
Property Type Description signingName
option<string>
The "service" value to use when creating a signing string for this endpoint. signingRegion
option<string>
The "region" value to use when creating a signing string for this endpoint. disableDoubleEncoding
option<boolean>
Default: false
. Whentrue
, clients MUST NOT double-escape the path during signing.disableNormalizePath
option<boolean>
Default: false
. Whentrue
, clients MUST NOT perform any path normalization during signing.
sigv4a
authentication scheme validator#
- Requirement
- The
name
property is the string valuesigv4a
. - Properties
Property Type Description signingName
option<string>
The "service" value to use when creating a signing string for this endpoint. signingRegionSet
array<string>
The set of signing regions to use when creating a signing string for this endpoint. disableDoubleEncoding
option<boolean>
Default: false
. Whentrue
, clients MUST NOT double-escape the path during signing.disableNormalizePath
option<boolean>
Default: false
. Whentrue
, clients MUST NOT perform any path normalization during signing.