Class UserPoolResourceServer

Defines a User Pool OAuth2.0 Resource Server.

Inheritance
object
Resource
UserPoolResourceServer
Inherited Members
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class UserPoolResourceServer : Resource, IUserPoolResourceServer, IResource, IUserPoolResourceServerRef, IConstruct, IDependable, IEnvironmentAware
Syntax (vb)
Public Class UserPoolResourceServer Inherits Resource Implements IUserPoolResourceServer, IResource, IUserPoolResourceServerRef, IConstruct, IDependable, IEnvironmentAware
Remarks

ExampleMetadata: infused

Examples
var pool = new UserPool(this, "Pool");

            var readOnlyScope = new ResourceServerScope(new ResourceServerScopeProps { ScopeName = "read", ScopeDescription = "Read-only access" });
            var fullAccessScope = new ResourceServerScope(new ResourceServerScopeProps { ScopeName = "*", ScopeDescription = "Full access" });

            var userServer = pool.AddResourceServer("ResourceServer", new UserPoolResourceServerOptions {
                Identifier = "users",
                Scopes = new [] { readOnlyScope, fullAccessScope }
            });

            var readOnlyClient = pool.AddClient("read-only-client", new UserPoolClientOptions {
                // ...
                OAuth = new OAuthSettings {
                    // ...
                    Scopes = new [] { OAuthScope.ResourceServer(userServer, readOnlyScope) }
                }
            });

            var fullAccessClient = pool.AddClient("full-access-client", new UserPoolClientOptions {
                // ...
                OAuth = new OAuthSettings {
                    // ...
                    Scopes = new [] { OAuthScope.ResourceServer(userServer, fullAccessScope) }
                }
            });

Synopsis

Constructors

UserPoolResourceServer(Construct, string, IUserPoolResourceServerProps)

Defines a User Pool OAuth2.0 Resource Server.

Properties

PROPERTY_INJECTION_ID

Uniquely identifies this class.
UserPoolResourceServerId

Resource server id.
UserPoolResourceServerRef

A reference to a UserPoolResourceServer resource.

Methods

FromUserPoolResourceServerId(Construct, string, string)

Import a user pool resource client given its id.

Constructors

UserPoolResourceServer(Construct, string, IUserPoolResourceServerProps)

Defines a User Pool OAuth2.0 Resource Server.

public UserPoolResourceServer(Construct scope, string id, IUserPoolResourceServerProps props)
Parameters
scope Construct
id string
props IUserPoolResourceServerProps
Remarks

ExampleMetadata: infused

Examples
var pool = new UserPool(this, "Pool");

            var readOnlyScope = new ResourceServerScope(new ResourceServerScopeProps { ScopeName = "read", ScopeDescription = "Read-only access" });
            var fullAccessScope = new ResourceServerScope(new ResourceServerScopeProps { ScopeName = "*", ScopeDescription = "Full access" });

            var userServer = pool.AddResourceServer("ResourceServer", new UserPoolResourceServerOptions {
                Identifier = "users",
                Scopes = new [] { readOnlyScope, fullAccessScope }
            });

            var readOnlyClient = pool.AddClient("read-only-client", new UserPoolClientOptions {
                // ...
                OAuth = new OAuthSettings {
                    // ...
                    Scopes = new [] { OAuthScope.ResourceServer(userServer, readOnlyScope) }
                }
            });

            var fullAccessClient = pool.AddClient("full-access-client", new UserPoolClientOptions {
                // ...
                OAuth = new OAuthSettings {
                    // ...
                    Scopes = new [] { OAuthScope.ResourceServer(userServer, fullAccessScope) }
                }
            });

Properties

PROPERTY_INJECTION_ID

Uniquely identifies this class.

public static string PROPERTY_INJECTION_ID { get; }
Property Value

string

Remarks

ExampleMetadata: infused

UserPoolResourceServerId

Resource server id.

public virtual string UserPoolResourceServerId { get; }
Property Value

string

Remarks

ExampleMetadata: infused

UserPoolResourceServerRef

A reference to a UserPoolResourceServer resource.

public virtual IUserPoolResourceServerReference UserPoolResourceServerRef { get; }
Property Value

IUserPoolResourceServerReference

Remarks

ExampleMetadata: infused

Methods

FromUserPoolResourceServerId(Construct, string, string)

Import a user pool resource client given its id.

public static IUserPoolResourceServer FromUserPoolResourceServerId(Construct scope, string id, string userPoolResourceServerId)
Parameters
scope Construct
id string
userPoolResourceServerId string
Returns

IUserPoolResourceServer

Remarks

ExampleMetadata: infused

Implements

Constructs.IConstruct
Constructs.IDependable