software.amazon.awssdk.services.amplifybackend.model

Class CreateBackendAuthOAuthConfig

java.lang.Object

software.amazon.awssdk.services.amplifybackend.model.CreateBackendAuthOAuthConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CreateBackendAuthOAuthConfig.Builder,CreateBackendAuthOAuthConfig>

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

Creates the OAuth configuration for your Amplify project.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateBackendAuthOAuthConfig.Builder

Method Summary

Modifier and Type	Method and Description
static CreateBackendAuthOAuthConfig.Builder	builder()
String	domainPrefix() The domain prefix for your Amplify app.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<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 that you use to allow app users to authenticate from your Amplify app.
String	oAuthGrantTypeAsString() The OAuth grant type that you use to allow app users to authenticate from your Amplify app.
List<OAuthScopesElement>	oAuthScopes() List of OAuth-related flows that allow your app users to authenticate from your Amplify app.
List<String>	oAuthScopesAsStrings() List of OAuth-related flows that allow your app users to authenticate from your Amplify app.
List<String>	redirectSignInURIs() The redirected URI for signing in to your 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 CreateBackendAuthOAuthConfig.Builder>	serializableBuilderClass()
SocialProviderSettings	socialProviderSettings() The settings for using social identity providers for access to your Amplify app.
CreateBackendAuthOAuthConfig.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

domainPrefix

public final String domainPrefix()

The domain prefix for your Amplify app.

Returns:

The domain prefix for your Amplify app.

oAuthGrantType

public final OAuthGrantType oAuthGrantType()

The OAuth grant type that you use 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().

Returns:

The OAuth grant type that you use to allow app users to authenticate from your Amplify app.

See Also:

OAuthGrantType

oAuthGrantTypeAsString

public final String oAuthGrantTypeAsString()

The OAuth grant type that you use 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().

Returns:

The OAuth grant type that you use to allow app users to authenticate from your Amplify app.

See Also:

OAuthGrantType

oAuthScopes

public final List<OAuthScopesElement> oAuthScopes()

List of OAuth-related flows that allow your app 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.

Returns:

List of OAuth-related flows that allow your app users to authenticate from your Amplify app.

hasOAuthScopes

public final 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). For responses returned by the SDK, the sender is the AWS service.

oAuthScopesAsStrings

public final List<String> oAuthScopesAsStrings()

List of OAuth-related flows that allow your app 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.

Returns:

List of OAuth-related flows that allow your app users to authenticate from your Amplify app.

hasRedirectSignInURIs

public final 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). For responses returned by the SDK, the sender is the AWS service.

redirectSignInURIs

public final List<String> redirectSignInURIs()

The redirected URI for signing in to your 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.

Returns:

The redirected URI for signing in to your Amplify app.

hasRedirectSignOutURIs

public final 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). For responses returned by the SDK, the sender is the AWS service.

redirectSignOutURIs

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.

Returns:

Redirect URLs that OAuth uses when a user signs out of an Amplify app.

socialProviderSettings

public final SocialProviderSettings socialProviderSettings()

The settings for using social identity providers for access to your Amplify app.

Returns:

The settings for using social identity providers for access to your Amplify app.

toBuilder

public CreateBackendAuthOAuthConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateBackendAuthOAuthConfig.Builder,CreateBackendAuthOAuthConfig>

builder

public static CreateBackendAuthOAuthConfig.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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