Struct ResourceServerType

#[non_exhaustive]
pub struct ResourceServerType {
    pub user_pool_id: Option<String>,
    pub identifier: Option<String>,
    pub name: Option<String>,
    pub scopes: Option<Vec<ResourceServerScopeType>>,
}

The details of a resource server configuration and associated custom scopes in a user pool.

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.

user_pool_id: Option<String>

The ID of the user pool that contains the resource server configuration.

identifier: Option<String>

A unique resource server identifier for the resource server. The identifier can be an API friendly name like solar-system-data. You can also set an API URL like https://solar-system-data-api.example.com as your identifier.

Amazon Cognito represents scopes in the access token in the format $resource-server-identifier/$scope. Longer scope-identifier strings increase the size of your access tokens.

name: Option<String>

The name of the resource server.

scopes: Option<Vec<ResourceServerScopeType>>

A list of scopes that are defined for the resource server.

Implementations

impl ResourceServerType

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

The ID of the user pool that contains the resource server configuration.

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

A unique resource server identifier for the resource server. The identifier can be an API friendly name like solar-system-data. You can also set an API URL like https://solar-system-data-api.example.com as your identifier.

Amazon Cognito represents scopes in the access token in the format $resource-server-identifier/$scope. Longer scope-identifier strings increase the size of your access tokens.

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

The name of the resource server.

pub fn scopes(&self) -> &[ResourceServerScopeType]

A list of scopes that are defined for the resource server.

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

impl ResourceServerType

pub fn builder() -> ResourceServerTypeBuilder

Creates a new builder-style object to manufacture ResourceServerType.

Trait Implementations

impl Clone for ResourceServerType

fn clone(&self) -> ResourceServerType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResourceServerType

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

Formats the value using the given formatter.

impl PartialEq for ResourceServerType

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

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

const 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 ResourceServerType