Interface CustomJWTAuthorizerConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<CustomJWTAuthorizerConfiguration.Builder,CustomJWTAuthorizerConfiguration>, SdkBuilder<CustomJWTAuthorizerConfiguration.Builder,CustomJWTAuthorizerConfiguration>, SdkPojo

Enclosing class:

CustomJWTAuthorizerConfiguration

@Mutable
@NotThreadSafe
public static interface CustomJWTAuthorizerConfiguration.Builder
extends SdkPojo, CopyableBuilder<CustomJWTAuthorizerConfiguration.Builder,CustomJWTAuthorizerConfiguration>

Method Summary

Modifier and Type	Method	Description
CustomJWTAuthorizerConfiguration.Builder	allowedAudience(String... allowedAudience)	The audience values accepted during JWT validation.
CustomJWTAuthorizerConfiguration.Builder	allowedAudience(Collection<String> allowedAudience)	The audience values accepted during JWT validation.
CustomJWTAuthorizerConfiguration.Builder	allowedClients(String... allowedClients)	The client identifiers accepted during JWT validation.
CustomJWTAuthorizerConfiguration.Builder	allowedClients(Collection<String> allowedClients)	The client identifiers accepted during JWT validation.
CustomJWTAuthorizerConfiguration.Builder	allowedScopes(String... allowedScopes)	The scopes accepted during JWT validation.
CustomJWTAuthorizerConfiguration.Builder	allowedScopes(Collection<String> allowedScopes)	The scopes accepted during JWT validation.
CustomJWTAuthorizerConfiguration.Builder	customClaims(Collection<CustomClaimValidationType> customClaims)	Additional custom claim validations applied to the inbound JWT.
CustomJWTAuthorizerConfiguration.Builder	customClaims(Consumer<CustomClaimValidationType.Builder>... customClaims)	Additional custom claim validations applied to the inbound JWT.
CustomJWTAuthorizerConfiguration.Builder	customClaims(CustomClaimValidationType... customClaims)	Additional custom claim validations applied to the inbound JWT.
CustomJWTAuthorizerConfiguration.Builder	discoveryUrl(String discoveryUrl)	The OpenID Connect discovery URL used to retrieve the identity provider's metadata and signing keys.
default CustomJWTAuthorizerConfiguration.Builder	privateEndpoint(Consumer<PrivateEndpoint.Builder> privateEndpoint)	The private endpoint used to reach the identity provider's discovery URL over a private network path.
CustomJWTAuthorizerConfiguration.Builder	privateEndpoint(PrivateEndpoint privateEndpoint)	The private endpoint used to reach the identity provider's discovery URL over a private network path.
CustomJWTAuthorizerConfiguration.Builder	privateEndpointOverrides(Collection<PrivateEndpointOverride> privateEndpointOverrides)	Per-domain private endpoint overrides that route specific identity provider domains through distinct private endpoints.
CustomJWTAuthorizerConfiguration.Builder	privateEndpointOverrides(Consumer<PrivateEndpointOverride.Builder>... privateEndpointOverrides)	Per-domain private endpoint overrides that route specific identity provider domains through distinct private endpoints.
CustomJWTAuthorizerConfiguration.Builder	privateEndpointOverrides(PrivateEndpointOverride... privateEndpointOverrides)	Per-domain private endpoint overrides that route specific identity provider domains through distinct private endpoints.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

discoveryUrl

CustomJWTAuthorizerConfiguration.Builder discoveryUrl(String discoveryUrl)

The OpenID Connect discovery URL used to retrieve the identity provider's metadata and signing keys.

Parameters:

discoveryUrl - The OpenID Connect discovery URL used to retrieve the identity provider's metadata and signing keys.

Returns:

Returns a reference to this object so that method calls can be chained together.

allowedAudience

CustomJWTAuthorizerConfiguration.Builder allowedAudience(Collection<String> allowedAudience)

The audience values accepted during JWT validation. A token is rejected if none of its audience claims match.

Parameters:

allowedAudience - The audience values accepted during JWT validation. A token is rejected if none of its audience claims match.

Returns:

Returns a reference to this object so that method calls can be chained together.

allowedAudience

CustomJWTAuthorizerConfiguration.Builder allowedAudience(String... allowedAudience)

The audience values accepted during JWT validation. A token is rejected if none of its audience claims match.

Parameters:

allowedAudience - The audience values accepted during JWT validation. A token is rejected if none of its audience claims match.

Returns:

Returns a reference to this object so that method calls can be chained together.

allowedClients

CustomJWTAuthorizerConfiguration.Builder allowedClients(Collection<String> allowedClients)

The client identifiers accepted during JWT validation. A token is rejected if it was not issued to one of these clients.

Parameters:

allowedClients - The client identifiers accepted during JWT validation. A token is rejected if it was not issued to one of these clients.

Returns:

Returns a reference to this object so that method calls can be chained together.

allowedClients

CustomJWTAuthorizerConfiguration.Builder allowedClients(String... allowedClients)

The client identifiers accepted during JWT validation. A token is rejected if it was not issued to one of these clients.

Parameters:

allowedClients - The client identifiers accepted during JWT validation. A token is rejected if it was not issued to one of these clients.

Returns:

Returns a reference to this object so that method calls can be chained together.

allowedScopes

CustomJWTAuthorizerConfiguration.Builder allowedScopes(Collection<String> allowedScopes)

The scopes accepted during JWT validation. A token is rejected if it does not carry one of these scopes.

Parameters:

allowedScopes - The scopes accepted during JWT validation. A token is rejected if it does not carry one of these scopes.

Returns:

Returns a reference to this object so that method calls can be chained together.

allowedScopes

CustomJWTAuthorizerConfiguration.Builder allowedScopes(String... allowedScopes)

The scopes accepted during JWT validation. A token is rejected if it does not carry one of these scopes.

Parameters:

allowedScopes - The scopes accepted during JWT validation. A token is rejected if it does not carry one of these scopes.

Returns:

Returns a reference to this object so that method calls can be chained together.

customClaims

CustomJWTAuthorizerConfiguration.Builder customClaims(Collection<CustomClaimValidationType> customClaims)

Additional custom claim validations applied to the inbound JWT.

Parameters:

customClaims - Additional custom claim validations applied to the inbound JWT.

Returns:

Returns a reference to this object so that method calls can be chained together.

customClaims

CustomJWTAuthorizerConfiguration.Builder customClaims(CustomClaimValidationType... customClaims)

Additional custom claim validations applied to the inbound JWT.

Parameters:

customClaims - Additional custom claim validations applied to the inbound JWT.

Returns:

Returns a reference to this object so that method calls can be chained together.

customClaims

CustomJWTAuthorizerConfiguration.Builder customClaims(Consumer<CustomClaimValidationType.Builder>... customClaims)

Additional custom claim validations applied to the inbound JWT.

This is a convenience method that creates an instance of the CustomClaimValidationType.Builder avoiding the need to create one manually via CustomClaimValidationType.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to customClaims(List<CustomClaimValidationType>).

Parameters:

customClaims - a consumer that will call methods on CustomClaimValidationType.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• customClaims(java.util.Collection<CustomClaimValidationType>)

privateEndpoint

CustomJWTAuthorizerConfiguration.Builder privateEndpoint(PrivateEndpoint privateEndpoint)

The private endpoint used to reach the identity provider's discovery URL over a private network path.

Parameters:

privateEndpoint - The private endpoint used to reach the identity provider's discovery URL over a private network path.

Returns:

Returns a reference to this object so that method calls can be chained together.

privateEndpoint

default CustomJWTAuthorizerConfiguration.Builder privateEndpoint(Consumer<PrivateEndpoint.Builder> privateEndpoint)

The private endpoint used to reach the identity provider's discovery URL over a private network path.

This is a convenience method that creates an instance of the PrivateEndpoint.Builder avoiding the need to create one manually via PrivateEndpoint.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to privateEndpoint(PrivateEndpoint).

Parameters:

privateEndpoint - a consumer that will call methods on PrivateEndpoint.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• privateEndpoint(PrivateEndpoint)

privateEndpointOverrides

CustomJWTAuthorizerConfiguration.Builder privateEndpointOverrides(Collection<PrivateEndpointOverride> privateEndpointOverrides)

Per-domain private endpoint overrides that route specific identity provider domains through distinct private endpoints.

Parameters:

privateEndpointOverrides - Per-domain private endpoint overrides that route specific identity provider domains through distinct private endpoints.

Returns:

Returns a reference to this object so that method calls can be chained together.

privateEndpointOverrides

CustomJWTAuthorizerConfiguration.Builder privateEndpointOverrides(PrivateEndpointOverride... privateEndpointOverrides)

Per-domain private endpoint overrides that route specific identity provider domains through distinct private endpoints.

Parameters:

privateEndpointOverrides - Per-domain private endpoint overrides that route specific identity provider domains through distinct private endpoints.

Returns:

Returns a reference to this object so that method calls can be chained together.

privateEndpointOverrides

CustomJWTAuthorizerConfiguration.Builder privateEndpointOverrides(Consumer<PrivateEndpointOverride.Builder>... privateEndpointOverrides)

Per-domain private endpoint overrides that route specific identity provider domains through distinct private endpoints.

This is a convenience method that creates an instance of the PrivateEndpointOverride.Builder avoiding the need to create one manually via PrivateEndpointOverride.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to privateEndpointOverrides(List<PrivateEndpointOverride>).

Parameters:

privateEndpointOverrides - a consumer that will call methods on PrivateEndpointOverride.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• privateEndpointOverrides(java.util.Collection<PrivateEndpointOverride>)