Class BackendAPIAppSyncAuthSettings

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

The authentication settings for accessing provisioned data models in your Amplify project.

See Also:

  • Method Details

    • cognitoUserPoolId

      public final String cognitoUserPoolId()

      The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models.

      Returns:
      The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models.

    • description

      public final String description()

      The API key description for API_KEY, if it was used as an authentication mechanism to access your data models.

      Returns:
      The API key description for API_KEY, if it was used as an authentication mechanism to access your data models.

    • expirationTime

      public final Double expirationTime()

      The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models.

      Returns:
      The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models.

    • openIDAuthTTL

      public final String openIDAuthTTL()

      The expiry time for the OpenID authentication mechanism.

      Returns:
      The expiry time for the OpenID authentication mechanism.

    • openIDClientId

      public final String openIDClientId()

      The clientID for openID, if openID was used as an authentication setting to access your data models.

      Returns:
      The clientID for openID, if openID was used as an authentication setting to access your data models.

    • openIDIatTTL

      public final String openIDIatTTL()

      The expiry time for the OpenID authentication mechanism.

      Returns:
      The expiry time for the OpenID authentication mechanism.

    • openIDIssueURL

      public final String openIDIssueURL()

      The openID issuer URL, if openID was used as an authentication setting to access your data models.

      Returns:
      The openID issuer URL, if openID was used as an authentication setting to access your data models.

    • openIDProviderName

      public final String openIDProviderName()

      The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models.

      Returns:
      The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models.

    • toBuilder

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

    • builder

      public static BackendAPIAppSyncAuthSettings.Builder builder()

    • serializableBuilderClass

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