@Generated(value="software.amazon.awssdk:codegen") public final class UpdateBackendAuthOAuthConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<UpdateBackendAuthOAuthConfig.Builder,UpdateBackendAuthOAuthConfig>
The OAuth configurations for authenticating users into your Amplify app.
Modifier and Type | Class and Description |
---|---|
static interface |
UpdateBackendAuthOAuthConfig.Builder |
Modifier and Type | Method and Description |
---|---|
static UpdateBackendAuthOAuthConfig.Builder |
builder() |
String |
domainPrefix()
The Amazon Cognito domain prefix used to create a hosted UI for authentication.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasOAuthScopes()
Returns true if the OAuthScopes property was specified by the sender (it may be empty), or false if the sender
did not specify the value (it will be empty).
|
boolean |
hasRedirectSignInURIs()
Returns true if the RedirectSignInURIs property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
boolean |
hasRedirectSignOutURIs()
Returns true if the RedirectSignOutURIs property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
OAuthGrantType |
oAuthGrantType()
The OAuth grant type to allow app users to authenticate from your Amplify app.
|
String |
oAuthGrantTypeAsString()
The OAuth grant type to allow app users to authenticate from your Amplify app.
|
List<OAuthScopesElement> |
oAuthScopes()
The list of OAuth-related flows that can allow users to authenticate from your Amplify app.
|
List<String> |
oAuthScopesAsStrings()
The list of OAuth-related flows that can allow users to authenticate from your Amplify app.
|
List<String> |
redirectSignInURIs()
Redirect URLs that OAuth uses when a user signs in to an Amplify app.
|
List<String> |
redirectSignOutURIs()
Redirect URLs that OAuth uses when a user signs out of an Amplify app.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends UpdateBackendAuthOAuthConfig.Builder> |
serializableBuilderClass() |
SocialProviderSettings |
socialProviderSettings()
Describes third-party social federation configurations for allowing your users to sign in with OAuth.
|
UpdateBackendAuthOAuthConfig.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
copy
public final String domainPrefix()
The Amazon Cognito domain prefix used to create a hosted UI for authentication.
public final OAuthGrantType oAuthGrantType()
The OAuth grant type to allow app users to authenticate from your Amplify app.
If the service returns an enum value that is not available in the current SDK version, oAuthGrantType
will return OAuthGrantType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from oAuthGrantTypeAsString()
.
OAuthGrantType
public final String oAuthGrantTypeAsString()
The OAuth grant type to allow app users to authenticate from your Amplify app.
If the service returns an enum value that is not available in the current SDK version, oAuthGrantType
will return OAuthGrantType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from oAuthGrantTypeAsString()
.
OAuthGrantType
public final List<OAuthScopesElement> oAuthScopes()
The list of OAuth-related flows that can allow users to authenticate from your Amplify app.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasOAuthScopes()
to see if a value was sent in this field.
public final boolean hasOAuthScopes()
public final List<String> oAuthScopesAsStrings()
The list of OAuth-related flows that can allow users to authenticate from your Amplify app.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasOAuthScopes()
to see if a value was sent in this field.
public final boolean hasRedirectSignInURIs()
public final List<String> redirectSignInURIs()
Redirect URLs that OAuth uses when a user signs in to an Amplify app.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasRedirectSignInURIs()
to see if a value was sent in this field.
public final boolean hasRedirectSignOutURIs()
public final List<String> redirectSignOutURIs()
Redirect URLs that OAuth uses when a user signs out of an Amplify app.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasRedirectSignOutURIs()
to see if a value was sent in this field.
public final SocialProviderSettings socialProviderSettings()
Describes third-party social federation configurations for allowing your users to sign in with OAuth.
public UpdateBackendAuthOAuthConfig.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<UpdateBackendAuthOAuthConfig.Builder,UpdateBackendAuthOAuthConfig>
public static UpdateBackendAuthOAuthConfig.Builder builder()
public static Class<? extends UpdateBackendAuthOAuthConfig.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()