Enum SigningHashAlgorithm

java.lang.Object

java.lang.Enum<SigningHashAlgorithm>

software.amazon.awssdk.services.cloudfront.utils.SigningHashAlgorithm

All Implemented Interfaces:

Serializable, Comparable<SigningHashAlgorithm>

@SdkPublicApi
public enum SigningHashAlgorithm
extends Enum<SigningHashAlgorithm>

The hash algorithm to use when generating CloudFront signed URLs or signed cookies.

CloudFront supports SHA-1 (default) and SHA-256 for signed URLs and signed cookies. When using SHA-256, the signed URL will include a Hash-Algorithm=SHA256 query parameter, and signed cookies will include a CloudFront-Hash-Algorithm=SHA256 cookie.

Enum Constant Summary

Enum Constants

Enum Constant	Description
SHA1
SHA256

Method Summary

Modifier and Type	Method	Description
String	id()	The algorithm identifier used in CloudFront's Hash-Algorithm parameter and in Java Security algorithm name construction (e.g., "SHA256withRSA").
static SigningHashAlgorithm	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SigningHashAlgorithm[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SHA1

public static final SigningHashAlgorithm SHA1

SHA256

public static final SigningHashAlgorithm SHA256

Method Details

values

public static SigningHashAlgorithm[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SigningHashAlgorithm valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

id

public String id()

The algorithm identifier used in CloudFront's Hash-Algorithm parameter and in Java Security algorithm name construction (e.g., "SHA256withRSA").