UpdateBackendAuthOAuthConfig (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 UpdateBackendAuthOAuthConfig

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateBackendAuthOAuthConfig
extends Object
implements Serializable, Cloneable, StructuredPojo 
```
The OAuth configurations for authenticating users into your Amplify app.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

UpdateBackendAuthOAuthConfig ()

Constructors
Constructor and Description
`UpdateBackendAuthOAuthConfig ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`UpdateBackendAuthOAuthConfig`	`clone ()`
`boolean`	`equals (Object obj)`
`String`	`getDomainPrefix ()` The Amazon Cognito domain prefix used to create a hosted UI for authentication.
`String`	`getOAuthGrantType ()` The OAuth grant type to allow app users to authenticate from your Amplify app.
`List<String>`	`getOAuthScopes ()` The list of OAuth-related flows that can allow users to authenticate from your Amplify app.
`List<String>`	`getRedirectSignInURIs ()` Redirect URLs that OAuth uses when a user signs in to an Amplify app.
`List<String>`	`getRedirectSignOutURIs ()` Redirect URLs that OAuth uses when a user signs out of an Amplify app.
`SocialProviderSettings`	`getSocialProviderSettings ()` Describes third-party social federation configurations for allowing your users to sign in with OAuth.
`int`	`hashCode ()`
`void`	`marshall (ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDomainPrefix (String domainPrefix)` The Amazon Cognito domain prefix used to create a hosted UI for authentication.
`void`	`setOAuthGrantType (String oAuthGrantType)` The OAuth grant type to allow app users to authenticate from your Amplify app.
`void`	`setOAuthScopes (Collection<String> oAuthScopes)` The list of OAuth-related flows that can allow users to authenticate from your Amplify app.
`void`	`setRedirectSignInURIs (Collection<String> redirectSignInURIs)` Redirect URLs that OAuth uses when a user signs in to an 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)` Describes third-party social federation configurations for allowing your users to sign in with OAuth.
`String`	`toString ()` Returns a string representation of this object.
`UpdateBackendAuthOAuthConfig`	`withDomainPrefix (String domainPrefix)` The Amazon Cognito domain prefix used to create a hosted UI for authentication.
`UpdateBackendAuthOAuthConfig`	`withOAuthGrantType (OAuthGrantType oAuthGrantType)` The OAuth grant type to allow app users to authenticate from your Amplify app.
`UpdateBackendAuthOAuthConfig`	`withOAuthGrantType (String oAuthGrantType)` The OAuth grant type to allow app users to authenticate from your Amplify app.
`UpdateBackendAuthOAuthConfig`	`withOAuthScopes (Collection<String> oAuthScopes)` The list of OAuth-related flows that can allow users to authenticate from your Amplify app.
`UpdateBackendAuthOAuthConfig`	`withOAuthScopes (OAuthScopesElement... oAuthScopes)` The list of OAuth-related flows that can allow users to authenticate from your Amplify app.
`UpdateBackendAuthOAuthConfig`	`withOAuthScopes (String... oAuthScopes)` The list of OAuth-related flows that can allow users to authenticate from your Amplify app.
`UpdateBackendAuthOAuthConfig`	`withRedirectSignInURIs (Collection<String> redirectSignInURIs)` Redirect URLs that OAuth uses when a user signs in to an Amplify app.
`UpdateBackendAuthOAuthConfig`	`withRedirectSignInURIs (String... redirectSignInURIs)` Redirect URLs that OAuth uses when a user signs in to an Amplify app.
`UpdateBackendAuthOAuthConfig`	`withRedirectSignOutURIs (Collection<String> redirectSignOutURIs)` Redirect URLs that OAuth uses when a user signs out of an Amplify app.
`UpdateBackendAuthOAuthConfig`	`withRedirectSignOutURIs (String... redirectSignOutURIs)` Redirect URLs that OAuth uses when a user signs out of an Amplify app.
`UpdateBackendAuthOAuthConfig`	`withSocialProviderSettings (SocialProviderSettings socialProviderSettings)` Describes third-party social federation configurations for allowing your users to sign in with OAuth.

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

- Constructor Detail
  - UpdateBackendAuthOAuthConfig
```
public UpdateBackendAuthOAuthConfig()
```
- Method Detail
  - setDomainPrefix
```
public void setDomainPrefix(String domainPrefix)
```
    The Amazon Cognito domain prefix used to create a hosted UI for authentication.
    
    Parameters:
    
    domainPrefix - The Amazon Cognito domain prefix used to create a hosted UI for authentication.
  - getDomainPrefix
```
public String getDomainPrefix()
```
    The Amazon Cognito domain prefix used to create a hosted UI for authentication.
    
    Returns:
    
    The Amazon Cognito domain prefix used to create a hosted UI for authentication.
  - withDomainPrefix
```
public UpdateBackendAuthOAuthConfig withDomainPrefix(String domainPrefix)
```
    The Amazon Cognito domain prefix used to create a hosted UI for authentication.
    
    Parameters:
    
    domainPrefix - The Amazon Cognito domain prefix used to create a hosted UI for authentication.
    
    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 to allow app users to authenticate from your Amplify app.
    
    Parameters:
    
    oAuthGrantType - The OAuth grant type to allow app users to authenticate from your Amplify app.
    
    See Also:
    
    OAuthGrantType
  - getOAuthGrantType
```
public String getOAuthGrantType()
```
    The OAuth grant type to allow app users to authenticate from your Amplify app.
    
    Returns:
    
    The OAuth grant type to allow app users to authenticate from your Amplify app.
    
    See Also:
    
    OAuthGrantType
  - withOAuthGrantType
```
public UpdateBackendAuthOAuthConfig withOAuthGrantType(String oAuthGrantType)
```
    The OAuth grant type to allow app users to authenticate from your Amplify app.
    
    Parameters:
    
    oAuthGrantType - The OAuth grant type 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 UpdateBackendAuthOAuthConfig withOAuthGrantType(OAuthGrantType oAuthGrantType)
```
    The OAuth grant type to allow app users to authenticate from your Amplify app.
    
    Parameters:
    
    oAuthGrantType - The OAuth grant type 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()
```
    The list of OAuth-related flows that can allow users to authenticate from your Amplify app.
    
    Returns:
    
    The list of OAuth-related flows that can allow users to authenticate from your Amplify app.
    
    See Also:
    
    OAuthScopesElement
  - setOAuthScopes
```
public void setOAuthScopes(Collection<String> oAuthScopes)
```
    The list of OAuth-related flows that can allow users to authenticate from your Amplify app.
    
    Parameters:
    
    oAuthScopes - The list of OAuth-related flows that can allow users to authenticate from your Amplify app.
    
    See Also:
    
    OAuthScopesElement
  - withOAuthScopes
```
public UpdateBackendAuthOAuthConfig withOAuthScopes(String... oAuthScopes)
```
    The list of OAuth-related flows that can allow 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 - The list of OAuth-related flows that can allow 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 UpdateBackendAuthOAuthConfig withOAuthScopes(Collection<String> oAuthScopes)
```
    The list of OAuth-related flows that can allow users to authenticate from your Amplify app.
    
    Parameters:
    
    oAuthScopes - The list of OAuth-related flows that can allow 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 UpdateBackendAuthOAuthConfig withOAuthScopes(OAuthScopesElement... oAuthScopes)
```
    The list of OAuth-related flows that can allow users to authenticate from your Amplify app.
    
    Parameters:
    
    oAuthScopes - The list of OAuth-related flows that can allow 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()
```
    Redirect URLs that OAuth uses when a user signs in to an Amplify app.
    
    Returns:
    
    Redirect URLs that OAuth uses when a user signs in to an Amplify app.
  - setRedirectSignInURIs
```
public void setRedirectSignInURIs(Collection<String> redirectSignInURIs)
```
    Redirect URLs that OAuth uses when a user signs in to an Amplify app.
    
    Parameters:
    
    redirectSignInURIs - Redirect URLs that OAuth uses when a user signs in to an Amplify app.
  - withRedirectSignInURIs
```
public UpdateBackendAuthOAuthConfig withRedirectSignInURIs(String... redirectSignInURIs)
```
    Redirect URLs that OAuth uses when a user signs in to an 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 - Redirect URLs that OAuth uses when a user signs in to an Amplify app.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withRedirectSignInURIs
```
public UpdateBackendAuthOAuthConfig withRedirectSignInURIs(Collection<String> redirectSignInURIs)
```
    Redirect URLs that OAuth uses when a user signs in to an Amplify app.
    
    Parameters:
    
    redirectSignInURIs - Redirect URLs that OAuth uses when a user signs in to an 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 UpdateBackendAuthOAuthConfig 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 UpdateBackendAuthOAuthConfig 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)
```
    Describes third-party social federation configurations for allowing your users to sign in with OAuth.
    
    Parameters:
    
    socialProviderSettings - Describes third-party social federation configurations for allowing your users to sign in with OAuth.
  - getSocialProviderSettings
```
public SocialProviderSettings getSocialProviderSettings()
```
    Describes third-party social federation configurations for allowing your users to sign in with OAuth.
    
    Returns:
    
    Describes third-party social federation configurations for allowing your users to sign in with OAuth.
  - withSocialProviderSettings
```
public UpdateBackendAuthOAuthConfig withSocialProviderSettings(SocialProviderSettings socialProviderSettings)
```
    Describes third-party social federation configurations for allowing your users to sign in with OAuth.
    
    Parameters:
    
    socialProviderSettings - Describes third-party social federation configurations for allowing your users to sign in with OAuth.
    
    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 UpdateBackendAuthOAuthConfig 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 UpdateBackendAuthOAuthConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UpdateBackendAuthOAuthConfig

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