Class OidcConfig

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

Use this parameter to configure your OIDC Identity Provider (IdP).

See Also:

  • Method Details

    • clientId

      public final String clientId()

      The OIDC IdP client ID used to configure your private workforce.

      Returns:
      The OIDC IdP client ID used to configure your private workforce.

    • clientSecret

      public final String clientSecret()

      The OIDC IdP client secret used to configure your private workforce.

      Returns:
      The OIDC IdP client secret used to configure your private workforce.

    • issuer

      public final String issuer()

      The OIDC IdP issuer used to configure your private workforce.

      Returns:
      The OIDC IdP issuer used to configure your private workforce.

    • authorizationEndpoint

      public final String authorizationEndpoint()

      The OIDC IdP authorization endpoint used to configure your private workforce.

      Returns:
      The OIDC IdP authorization endpoint used to configure your private workforce.

    • tokenEndpoint

      public final String tokenEndpoint()

      The OIDC IdP token endpoint used to configure your private workforce.

      Returns:
      The OIDC IdP token endpoint used to configure your private workforce.

    • userInfoEndpoint

      public final String userInfoEndpoint()

      The OIDC IdP user information endpoint used to configure your private workforce.

      Returns:
      The OIDC IdP user information endpoint used to configure your private workforce.

    • logoutEndpoint

      public final String logoutEndpoint()

      The OIDC IdP logout endpoint used to configure your private workforce.

      Returns:
      The OIDC IdP logout endpoint used to configure your private workforce.

    • jwksUri

      public final String jwksUri()

      The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.

      Returns:
      The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.

    • scope

      public final String scope()

      An array of string identifiers used to refer to the specific pieces of user data or claims that the client application wants to access.

      Returns:
      An array of string identifiers used to refer to the specific pieces of user data or claims that the client application wants to access.

    • hasAuthenticationRequestExtraParams

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

    • authenticationRequestExtraParams

      public final Map<String,String> authenticationRequestExtraParams()

      A string to string map of identifiers specific to the custom identity provider (IdP) being used.

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

      Returns:
      A string to string map of identifiers specific to the custom identity provider (IdP) being used.

    • toBuilder

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

    • builder

      public static OidcConfig.Builder builder()

    • serializableBuilderClass

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