Header menu logo FsCDK

UserPoolResourceServerBuilder Type

Constructors

Constructor Description

UserPoolResourceServerBuilder(name)

Full Usage: UserPoolResourceServerBuilder(name)

Parameters:
    name : string

Returns: UserPoolResourceServerBuilder
name : string
Returns: UserPoolResourceServerBuilder

Instance members

Instance member Description
a : UserPoolResourceServerConfig
b : UserPoolResourceServerConfig
Returns: UserPoolResourceServerConfig

constructId id

Full Usage: constructId id

Parameters:
    id : string

Returns: UserPoolResourceServerConfig
id : string
Returns: UserPoolResourceServerConfig

this.Delay

Full Usage: this.Delay

Parameters:
Returns: UserPoolResourceServerConfig
Modifiers: inline
f : unit -> UserPoolResourceServerConfig
Returns: UserPoolResourceServerConfig

this.For

Full Usage: this.For

Parameters:
Returns: UserPoolResourceServerConfig
Modifiers: inline
config : UserPoolResourceServerConfig
f : unit -> UserPoolResourceServerConfig
Returns: UserPoolResourceServerConfig

identifier id

Full Usage: identifier id

Parameters:
    id : string - The resource server identifier, e.g., api or com.example.api.

Returns: UserPoolResourceServerConfig

Sets the identifier used by OAuth2 to reference this resource server.

id : string

The resource server identifier, e.g., api or com.example.api.

Returns: UserPoolResourceServerConfig

name name

Full Usage: name name

Parameters:
    name : string - The resource server name.

Returns: UserPoolResourceServerConfig

Sets the display name for the resource server.

name : string

The resource server name.

Returns: UserPoolResourceServerConfig

this.Run

Full Usage: this.Run

Parameters:
Returns: UserPoolResourceServerSpec
config : UserPoolResourceServerConfig
Returns: UserPoolResourceServerSpec

scope name description

Full Usage: scope name description

Parameters:
    name : string - The scope name.
    description : string - The scope description.

Returns: UserPoolResourceServerConfig

Adds a single scope from a name/description tuple.

name : string

The scope name.

description : string

The scope description.

Returns: UserPoolResourceServerConfig

scope scope

Full Usage: scope scope

Parameters:
Returns: UserPoolResourceServerConfig

Adds a single scope using an existing ResourceServerScopeProps value.

scope : ResourceServerScopeProps

The scope definition.

Returns: UserPoolResourceServerConfig

scopes scopes

Full Usage: scopes scopes

Parameters:
    scopes : (string * string) list - A list of tuples where each item is (name, description).

Returns: UserPoolResourceServerConfig

Sets all scopes using a list of name/description tuples.

scopes : (string * string) list

A list of tuples where each item is (name, description).

Returns: UserPoolResourceServerConfig

scopes scopes

Full Usage: scopes scopes

Parameters:
Returns: UserPoolResourceServerConfig

Sets all scopes at once using a list of ResourceServerScopeProps.

scopes : ResourceServerScopeProps list

The list of scope definitions.

Returns: UserPoolResourceServerConfig

userPool pool

Full Usage: userPool pool

Parameters:
Returns: UserPoolResourceServerConfig

Sets the user pool associated with this resource server.

pool : IUserPool

The Cognito user pool.

Returns: UserPoolResourceServerConfig

this.Yield

Full Usage: this.Yield

Parameters:
    () : unit

Returns: UserPoolResourceServerConfig
() : unit
Returns: UserPoolResourceServerConfig

this.Zero

Full Usage: this.Zero

Returns: UserPoolResourceServerConfig
Returns: UserPoolResourceServerConfig

Type something to start searching.