CreateBackendAuthOAuthConfig (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.amplifybackend.model

Class CreateBackendAuthOAuthConfig

java.lang.Object
- com.amazonaws.services.amplifybackend.model.CreateBackendAuthOAuthConfig

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateBackendAuthOAuthConfig
extends Object
implements Serializable, Cloneable, StructuredPojo

Creates the OAuth configuration for your Amplify project.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CreateBackendAuthOAuthConfig ()

Constructors
Constructor and Description
`CreateBackendAuthOAuthConfig ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`CreateBackendAuthOAuthConfig`	`clone ()`
`boolean`	`equals (Object obj)`
`String`	`getDomainPrefix ()` The domain prefix for your Amplify app.
`String`	`getOAuthGrantType ()` The OAuth grant type that you use to allow app users to authenticate from your Amplify app.
`List<String>`	`getOAuthScopes ()` List of OAuth-related flows used to allow your app users to authenticate from your Amplify app.
`List<String>`	`getRedirectSignInURIs ()` The redirected URI for signing in to your Amplify app.
`List<String>`	`getRedirectSignOutURIs ()` Redirect URLs that OAuth uses when a user signs out of an Amplify app.
`SocialProviderSettings`	`getSocialProviderSettings ()` The settings for using social providers to access your Amplify app.
`int`	`hashCode ()`
`void`	`marshall (ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDomainPrefix (String domainPrefix)` The domain prefix for your Amplify app.
`void`	`setOAuthGrantType (String oAuthGrantType)` The OAuth grant type that you use to allow app users to authenticate from your Amplify app.
`void`	`setOAuthScopes (Collection<String> oAuthScopes)` List of OAuth-related flows used to allow your app users to authenticate from your Amplify app.
`void`	`setRedirectSignInURIs (Collection<String> redirectSignInURIs)` The redirected URI for signing in to your Amplify app.
`void`	`setRedirectSignOutURIs (Collection<String> redirectSignOutURIs)` Redirect URLs that OAuth uses when a user signs out of an Amplify app.
`void`	`setSocialProviderSettings (SocialProviderSettings socialProviderSettings)` The settings for using social providers to access your Amplify app.
`String`	`toString ()` Returns a string representation of this object.
`CreateBackendAuthOAuthConfig`	`withDomainPrefix (String domainPrefix)` The domain prefix for your Amplify app.
`CreateBackendAuthOAuthConfig`	`withOAuthGrantType (OAuthGrantType oAuthGrantType)` The OAuth grant type that you use to allow app users to authenticate from your Amplify app.
`CreateBackendAuthOAuthConfig`	`withOAuthGrantType (String oAuthGrantType)` The OAuth grant type that you use to allow app users to authenticate from your Amplify app.
`CreateBackendAuthOAuthConfig`	`withOAuthScopes (Collection<String> oAuthScopes)` List of OAuth-related flows used to allow your app users to authenticate from your Amplify app.
`CreateBackendAuthOAuthConfig`	`withOAuthScopes (OAuthScopesElement... oAuthScopes)` List of OAuth-related flows used to allow your app users to authenticate from your Amplify app.
`CreateBackendAuthOAuthConfig`	`withOAuthScopes (String... oAuthScopes)` List of OAuth-related flows used to allow your app users to authenticate from your Amplify app.
`CreateBackendAuthOAuthConfig`	`withRedirectSignInURIs (Collection<String> redirectSignInURIs)` The redirected URI for signing in to your Amplify app.
`CreateBackendAuthOAuthConfig`	`withRedirectSignInURIs (String... redirectSignInURIs)` The redirected URI for signing in to your Amplify app.
`CreateBackendAuthOAuthConfig`	`withRedirectSignOutURIs (Collection<String> redirectSignOutURIs)` Redirect URLs that OAuth uses when a user signs out of an Amplify app.
`CreateBackendAuthOAuthConfig`	`withRedirectSignOutURIs (String... redirectSignOutURIs)` Redirect URLs that OAuth uses when a user signs out of an Amplify app.
`CreateBackendAuthOAuthConfig`	`withSocialProviderSettings (SocialProviderSettings socialProviderSettings)` The settings for using social providers to access your Amplify app.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreateBackendAuthOAuthConfig
```
public CreateBackendAuthOAuthConfig()
```
- Method Detail
  - setDomainPrefix
```
public void setDomainPrefix(String domainPrefix)
```
    The domain prefix for your Amplify app.
    
    Parameters:
    
    domainPrefix - The domain prefix for your Amplify app.
  - getDomainPrefix
```
public String getDomainPrefix()
```
    The domain prefix for your Amplify app.
    
    Returns:
    
    The domain prefix for your Amplify app.
  - withDomainPrefix
```
public CreateBackendAuthOAuthConfig withDomainPrefix(String domainPrefix)
```
    The domain prefix for your Amplify app.
    
    Parameters:
    
    domainPrefix - The domain prefix for your Amplify app.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOAuthGrantType
```
public void setOAuthGrantType(String oAuthGrantType)
```
    The OAuth grant type that you use to allow app users to authenticate from your Amplify app.
    
    Parameters:
    
    oAuthGrantType - The OAuth grant type that you use to allow app users to authenticate from your Amplify app.
    
    See Also:
    
    OAuthGrantType
  - getOAuthGrantType
```
public String getOAuthGrantType()
```
    The OAuth grant type that you use to allow app users to authenticate from your Amplify app.
    
    Returns:
    
    The OAuth grant type that you use to allow app users to authenticate from your Amplify app.
    
    See Also:
    
    OAuthGrantType
  - withOAuthGrantType
```
public CreateBackendAuthOAuthConfig withOAuthGrantType(String oAuthGrantType)
```
    The OAuth grant type that you use to allow app users to authenticate from your Amplify app.
    
    Parameters:
    
    oAuthGrantType - The OAuth grant type that you use to allow app users to authenticate from your Amplify app.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OAuthGrantType
  - withOAuthGrantType
```
public CreateBackendAuthOAuthConfig withOAuthGrantType(OAuthGrantType oAuthGrantType)
```
    The OAuth grant type that you use to allow app users to authenticate from your Amplify app.
    
    Parameters:
    
    oAuthGrantType - The OAuth grant type that you use to allow app users to authenticate from your Amplify app.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OAuthGrantType
  - getOAuthScopes
```
public List<String> getOAuthScopes()
```
    List of OAuth-related flows used to allow your app users to authenticate from your Amplify app.
    
    Returns:
    
    List of OAuth-related flows used to allow your app users to authenticate from your Amplify app.
    
    See Also:
    
    OAuthScopesElement
  - setOAuthScopes
```
public void setOAuthScopes(Collection<String> oAuthScopes)
```
    List of OAuth-related flows used to allow your app users to authenticate from your Amplify app.
    
    Parameters:
    
    oAuthScopes - List of OAuth-related flows used to allow your app users to authenticate from your Amplify app.
    
    See Also:
    
    OAuthScopesElement
  - withOAuthScopes
```
public CreateBackendAuthOAuthConfig withOAuthScopes(String... oAuthScopes)
```
    List of OAuth-related flows used to allow your app users to authenticate from your Amplify app.
    
    NOTE: This method appends the values to the existing list (if any). Use setOAuthScopes(java.util.Collection) or withOAuthScopes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    oAuthScopes - List of OAuth-related flows used to allow your app users to authenticate from your Amplify app.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OAuthScopesElement
  - withOAuthScopes
```
public CreateBackendAuthOAuthConfig withOAuthScopes(Collection<String> oAuthScopes)
```
    List of OAuth-related flows used to allow your app users to authenticate from your Amplify app.
    
    Parameters:
    
    oAuthScopes - List of OAuth-related flows used to allow your app users to authenticate from your Amplify app.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OAuthScopesElement
  - withOAuthScopes
```
public CreateBackendAuthOAuthConfig withOAuthScopes(OAuthScopesElement... oAuthScopes)
```
    List of OAuth-related flows used to allow your app users to authenticate from your Amplify app.
    
    Parameters:
    
    oAuthScopes - List of OAuth-related flows used to allow your app users to authenticate from your Amplify app.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OAuthScopesElement
  - getRedirectSignInURIs
```
public List<String> getRedirectSignInURIs()
```
    The redirected URI for signing in to your Amplify app.
    
    Returns:
    
    The redirected URI for signing in to your Amplify app.
  - setRedirectSignInURIs
```
public void setRedirectSignInURIs(Collection<String> redirectSignInURIs)
```
    The redirected URI for signing in to your Amplify app.
    
    Parameters:
    
    redirectSignInURIs - The redirected URI for signing in to your Amplify app.
  - withRedirectSignInURIs
```
public CreateBackendAuthOAuthConfig withRedirectSignInURIs(String... redirectSignInURIs)
```
    The redirected URI for signing in to your Amplify app.
    
    NOTE: This method appends the values to the existing list (if any). Use setRedirectSignInURIs(java.util.Collection) or withRedirectSignInURIs(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    redirectSignInURIs - The redirected URI for signing in to your Amplify app.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withRedirectSignInURIs
```
public CreateBackendAuthOAuthConfig withRedirectSignInURIs(Collection<String> redirectSignInURIs)
```
    The redirected URI for signing in to your Amplify app.
    
    Parameters:
    
    redirectSignInURIs - The redirected URI for signing in to your Amplify app.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getRedirectSignOutURIs
```
public List<String> getRedirectSignOutURIs()
```
    Redirect URLs that OAuth uses when a user signs out of an Amplify app.
    
    Returns:
    
    Redirect URLs that OAuth uses when a user signs out of an Amplify app.
  - setRedirectSignOutURIs
```
public void setRedirectSignOutURIs(Collection<String> redirectSignOutURIs)
```
    Redirect URLs that OAuth uses when a user signs out of an Amplify app.
    
    Parameters:
    
    redirectSignOutURIs - Redirect URLs that OAuth uses when a user signs out of an Amplify app.
  - withRedirectSignOutURIs
```
public CreateBackendAuthOAuthConfig withRedirectSignOutURIs(String... redirectSignOutURIs)
```
    Redirect URLs that OAuth uses when a user signs out of an Amplify app.
    
    NOTE: This method appends the values to the existing list (if any). Use setRedirectSignOutURIs(java.util.Collection) or withRedirectSignOutURIs(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    redirectSignOutURIs - Redirect URLs that OAuth uses when a user signs out of an Amplify app.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withRedirectSignOutURIs
```
public CreateBackendAuthOAuthConfig withRedirectSignOutURIs(Collection<String> redirectSignOutURIs)
```
    Redirect URLs that OAuth uses when a user signs out of an Amplify app.
    
    Parameters:
    
    redirectSignOutURIs - Redirect URLs that OAuth uses when a user signs out of an Amplify app.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSocialProviderSettings
```
public void setSocialProviderSettings(SocialProviderSettings socialProviderSettings)
```
    The settings for using social providers to access your Amplify app.
    
    Parameters:
    
    socialProviderSettings - The settings for using social providers to access your Amplify app.
  - getSocialProviderSettings
```
public SocialProviderSettings getSocialProviderSettings()
```
    The settings for using social providers to access your Amplify app.
    
    Returns:
    
    The settings for using social providers to access your Amplify app.
  - withSocialProviderSettings
```
public CreateBackendAuthOAuthConfig withSocialProviderSettings(SocialProviderSettings socialProviderSettings)
```
    The settings for using social providers to access your Amplify app.
    
    Parameters:
    
    socialProviderSettings - The settings for using social providers to access your Amplify app.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CreateBackendAuthOAuthConfig clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class CreateBackendAuthOAuthConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CreateBackendAuthOAuthConfig

Method Detail

setDomainPrefix

getDomainPrefix

withDomainPrefix

setOAuthGrantType

getOAuthGrantType

withOAuthGrantType

withOAuthGrantType

getOAuthScopes

setOAuthScopes

withOAuthScopes

withOAuthScopes

withOAuthScopes

getRedirectSignInURIs

setRedirectSignInURIs

withRedirectSignInURIs

withRedirectSignInURIs

getRedirectSignOutURIs

setRedirectSignOutURIs

withRedirectSignOutURIs

withRedirectSignOutURIs

setSocialProviderSettings

getSocialProviderSettings

withSocialProviderSettings

toString

equals

hashCode

clone

marshall