Struct UpdateBackendAuthOAuthConfig

#[non_exhaustive]
pub struct UpdateBackendAuthOAuthConfig {
    pub domain_prefix: Option<String>,
    pub o_auth_grant_type: Option<OAuthGrantType>,
    pub o_auth_scopes: Option<Vec<OAuthScopesElement>>,
    pub redirect_sign_in_uris: Option<Vec<String>>,
    pub redirect_sign_out_uris: Option<Vec<String>>,
    pub social_provider_settings: Option<SocialProviderSettings>,
}

The OAuth configurations for authenticating users into your Amplify app.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

domain_prefix: Option<String>

The Amazon Cognito domain prefix used to create a hosted UI for authentication.

o_auth_grant_type: Option<OAuthGrantType>

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

o_auth_scopes: Option<Vec<OAuthScopesElement>>

The list of OAuth-related flows that can allow users to authenticate from your Amplify app.

redirect_sign_in_uris: Option<Vec<String>>

Redirect URLs that OAuth uses when a user signs in to an Amplify app.

redirect_sign_out_uris: Option<Vec<String>>

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

social_provider_settings: Option<SocialProviderSettings>

Describes third-party social federation configurations for allowing your users to sign in with OAuth.

Implementations

impl UpdateBackendAuthOAuthConfig

pub fn domain_prefix(&self) -> Option<&str>

The Amazon Cognito domain prefix used to create a hosted UI for authentication.

pub fn o_auth_grant_type(&self) -> Option<&OAuthGrantType>

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

pub fn o_auth_scopes(&self) -> &[OAuthScopesElement]

The list of OAuth-related flows that can allow users to authenticate from your Amplify app.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .o_auth_scopes.is_none().

pub fn redirect_sign_in_uris(&self) -> &[String]

Redirect URLs that OAuth uses when a user signs in to an Amplify app.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .redirect_sign_in_uris.is_none().

pub fn redirect_sign_out_uris(&self) -> &[String]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .redirect_sign_out_uris.is_none().

pub fn social_provider_settings(&self) -> Option<&SocialProviderSettings>

Describes third-party social federation configurations for allowing your users to sign in with OAuth.

impl UpdateBackendAuthOAuthConfig

pub fn builder() -> UpdateBackendAuthOAuthConfigBuilder

Creates a new builder-style object to manufacture UpdateBackendAuthOAuthConfig.

Trait Implementations

impl Clone for UpdateBackendAuthOAuthConfig

fn clone(&self) -> UpdateBackendAuthOAuthConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UpdateBackendAuthOAuthConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for UpdateBackendAuthOAuthConfig

fn eq(&self, other: &UpdateBackendAuthOAuthConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for UpdateBackendAuthOAuthConfig