Class JwtIssuerInput

java.lang.Object
software.amazon.awssdk.services.apigateway.model.JwtIssuerInput
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<JwtIssuerInput.Builder,JwtIssuerInput>

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

A trusted issuer in the JWT configuration.

See Also:
  • Method Details

    • issuer

      public final String issuer()

      The OpenID Connect (OIDC) issuer URL. The value must be an absolute https URL that includes a host and has no user information, query, or fragment. It must exactly match the iss claim of the token, and the issuer's OIDC discovery document must name this exact issuer.

      Returns:
      The OpenID Connect (OIDC) issuer URL. The value must be an absolute https URL that includes a host and has no user information, query, or fragment. It must exactly match the iss claim of the token, and the issuer's OIDC discovery document must name this exact issuer.
    • hasAudiences

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

      public final List<String> audiences()

      The audiences that the issuer can issue tokens for. None can be empty. The token's aud claim must contain at least one of these values.

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

      Returns:
      The audiences that the issuer can issue tokens for. None can be empty. The token's aud claim must contain at least one of these values.
    • hasAdditionalClaims

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

      public final List<JwtAdditionalClaim> additionalClaims()

      The additional claim rules for this issuer. Claim names must be unique within the issuer.

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

      Returns:
      The additional claim rules for this issuer. Claim names must be unique within the issuer.
    • toBuilder

      public JwtIssuerInput.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<JwtIssuerInput.Builder,JwtIssuerInput>
      Returns:
      a builder for type T
    • builder

      public static JwtIssuerInput.Builder builder()
    • serializableBuilderClass

      public static Class<? extends JwtIssuerInput.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.