Package software.amazon.awssdk.services.apigatewayv2.model

Class JWTConfiguration

java.lang.Object

software.amazon.awssdk.services.apigatewayv2.model.JWTConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<JWTConfiguration.Builder,JWTConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class JWTConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<JWTConfiguration.Builder,JWTConfiguration>

Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	JWTConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
List<String>	audience()	A list of the intended recipients of the JWT.
static JWTConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAudience()	For responses, this returns true if the service returned a value for the Audience property.
int	hashCode()
String	issuer()	The base domain of the identity provider that issues JSON Web Tokens.
List<SdkField<?>>	sdkFields()
static Class<? extends JWTConfiguration.Builder>	serializableBuilderClass()
JWTConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hasAudience

public final boolean hasAudience()

For responses, this returns true if the service returned a value for the Audience property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

audience

public final List<String> audience()

A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list. See RFC 7519. Supported only for HTTP APIs.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAudience() method.

Returns:

A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list. See RFC 7519. Supported only for HTTP APIs.

issuer

public final String issuer()

The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: https://cognito-idp.{region}.amazonaws.com/{userPoolId} . Required for the JWT authorizer type. Supported only for HTTP APIs.

Returns:

The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: https://cognito-idp.{region}.amazonaws.com/{userPoolId} . Required for the JWT authorizer type. Supported only for HTTP APIs.

toBuilder

public JWTConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<JWTConfiguration.Builder,JWTConfiguration>

builder

public static JWTConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends JWTConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo