Package software.amazon.smithy.rulesengine.aws.language.functions

Class EndpointAuthUtils

java.lang.Object

software.amazon.smithy.rulesengine.aws.language.functions.EndpointAuthUtils

public final class EndpointAuthUtils
extends Object

Utilities for constructing and validating AWS-specific authentication components for rule-sets.

Method Summary

Modifier and Type	Method	Description
static boolean	isSigV4AEquivalentAuthScheme(String authScheme)	Returns if a given auth scheme is equivalent to aws.auth#sigv4a.
static boolean	isSigV4EquivalentAuthScheme(String authScheme)	Returns if a given auth scheme is equivalent to aws.auth#sigv4.
static Endpoint.Builder	sigv4(Endpoint.Builder builder, Literal signingRegion, Literal signingService)	Adds SigV4 authentication to the provided endpoint builder.
static Endpoint.Builder	sigv4a(Endpoint.Builder builder, List<Literal> signingRegionSet, Literal signingService)	Adds SigV4a authentication to the provided endpoint builder.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

sigv4

public static Endpoint.Builder sigv4(Endpoint.Builder builder,
 Literal signingRegion,
 Literal signingService)

Adds SigV4 authentication to the provided endpoint builder.

Parameters:

builder - the endpoint builder to augment.

signingRegion - the signing region to use when signing.

signingService - the name of the service to sign with.

Returns:

the updated endpoint builder.

sigv4a

public static Endpoint.Builder sigv4a(Endpoint.Builder builder,
 List<Literal> signingRegionSet,
 Literal signingService)

Adds SigV4a authentication to the provided endpoint builder.

Parameters:

builder - the endpoint builder to augment.

signingRegionSet - the set of signing regions to use when signing.

signingService - the name of the service to sign with.

Returns:

the updated endpoint builder.

isSigV4EquivalentAuthScheme

public static boolean isSigV4EquivalentAuthScheme(String authScheme)

Returns if a given auth scheme is equivalent to aws.auth#sigv4.

Parameters:

authScheme - name of the auth scheme.

Returns:

whether the auth scheme is equivalent to aws.auth#sigv4.

isSigV4AEquivalentAuthScheme

public static boolean isSigV4AEquivalentAuthScheme(String authScheme)

Returns if a given auth scheme is equivalent to aws.auth#sigv4a.

Parameters:

authScheme - name of the auth scheme.

Returns:

whether the auth scheme is equivalent to aws.auth#sigv4a.