Class CustomJWTAuthorizerConfiguration

java.lang.Object
software.amazon.awssdk.services.agentregistrycontrol.model.CustomJWTAuthorizerConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CustomJWTAuthorizerConfiguration.Builder,CustomJWTAuthorizerConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class CustomJWTAuthorizerConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CustomJWTAuthorizerConfiguration.Builder,CustomJWTAuthorizerConfiguration>

Configuration for a custom JWT authorizer that validates inbound bearer tokens against an OpenID Connect identity provider.

See Also:

  • Method Details

    • discoveryUrl

      public final String discoveryUrl()

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

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

    • hasAllowedAudience

      public final boolean hasAllowedAudience()
      For responses, this returns true if the service returned a value for the AllowedAudience 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.

    • allowedAudience

      public final List<String> allowedAudience()

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

      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 hasAllowedAudience() method.

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

    • hasAllowedClients

      public final boolean hasAllowedClients()
      For responses, this returns true if the service returned a value for the AllowedClients 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.

    • allowedClients

      public final List<String> allowedClients()

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

      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 hasAllowedClients() method.

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

    • hasAllowedScopes

      public final boolean hasAllowedScopes()
      For responses, this returns true if the service returned a value for the AllowedScopes 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.

    • allowedScopes

      public final List<String> allowedScopes()

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

      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 hasAllowedScopes() method.

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

    • hasCustomClaims

      public final boolean hasCustomClaims()
      For responses, this returns true if the service returned a value for the CustomClaims 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.

    • customClaims

      public final List<CustomClaimValidationType> customClaims()

      Additional custom claim validations applied to the inbound JWT.

      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 hasCustomClaims() method.

      Returns:
      Additional custom claim validations applied to the inbound JWT.

    • privateEndpoint

      public final PrivateEndpoint privateEndpoint()

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

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

    • hasPrivateEndpointOverrides

      public final boolean hasPrivateEndpointOverrides()
      For responses, this returns true if the service returned a value for the PrivateEndpointOverrides 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.

    • privateEndpointOverrides

      public final List<PrivateEndpointOverride> privateEndpointOverrides()

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

      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 hasPrivateEndpointOverrides() method.

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

    • toBuilder

      public CustomJWTAuthorizerConfiguration.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CustomJWTAuthorizerConfiguration.Builder,CustomJWTAuthorizerConfiguration>
      Returns:
      a builder for type T

    • builder

      public static CustomJWTAuthorizerConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CustomJWTAuthorizerConfiguration.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.