software.amazon.awscdk.services.cognito

Class UserPoolResourceServer

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.cognito.UserPoolResourceServer

All Implemented Interfaces:

IResource, IUserPoolResourceServer, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.697Z")
 @Stability(value=Stable)
public class UserPoolResourceServer
extends Resource
implements IUserPoolResourceServer

Defines a User Pool OAuth2.0 Resource Server.

Example:

 UserPool pool = new UserPool(this, "Pool");
 ResourceServerScope readOnlyScope = ResourceServerScope.Builder.create().scopeName("read").scopeDescription("Read-only access").build();
 ResourceServerScope fullAccessScope = ResourceServerScope.Builder.create().scopeName("*").scopeDescription("Full access").build();
 UserPoolResourceServer userServer = pool.addResourceServer("ResourceServer", UserPoolResourceServerOptions.builder()
         .identifier("users")
         .scopes(List.of(readOnlyScope, fullAccessScope))
         .build());
 UserPoolClient readOnlyClient = pool.addClient("read-only-client", UserPoolClientOptions.builder()
         // ...
         .oAuth(OAuthSettings.builder()
                 // ...
                 .scopes(List.of(OAuthScope.resourceServer(userServer, readOnlyScope)))
                 .build())
         .build());
 UserPoolClient fullAccessClient = pool.addClient("full-access-client", UserPoolClientOptions.builder()
         // ...
         .oAuth(OAuthSettings.builder()
                 // ...
                 .scopes(List.of(OAuthScope.resourceServer(userServer, fullAccessScope)))
                 .build())
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UserPoolResourceServer.Builder A fluent builder for UserPoolResourceServer.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.cognito.IUserPoolResourceServer

IUserPoolResourceServer.Jsii$Default, IUserPoolResourceServer.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	UserPoolResourceServer(software.constructs.Construct scope, String id, UserPoolResourceServerProps props)
protected	UserPoolResourceServer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	UserPoolResourceServer(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static IUserPoolResourceServer	fromUserPoolResourceServerId(software.constructs.Construct scope, String id, String userPoolResourceServerId) Import a user pool resource client given its id.
String	getUserPoolResourceServerId() Resource server id.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

UserPoolResourceServer

protected UserPoolResourceServer(software.amazon.jsii.JsiiObjectRef objRef)

UserPoolResourceServer

protected UserPoolResourceServer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

UserPoolResourceServer

@Stability(value=Stable)
public UserPoolResourceServer(@NotNull
                                                       software.constructs.Construct scope,
                                                       @NotNull
                                                       String id,
                                                       @NotNull
                                                       UserPoolResourceServerProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromUserPoolResourceServerId

@Stability(value=Stable)
 @NotNull
public static IUserPoolResourceServer fromUserPoolResourceServerId(@NotNull
                                                                                                      software.constructs.Construct scope,
                                                                                                      @NotNull
                                                                                                      String id,
                                                                                                      @NotNull
                                                                                                      String userPoolResourceServerId)

Import a user pool resource client given its id.

Parameters:

scope - This parameter is required.

id - This parameter is required.

userPoolResourceServerId - This parameter is required.

getUserPoolResourceServerId

@Stability(value=Stable)
 @NotNull
public String getUserPoolResourceServerId()

Resource server id.

Specified by:

getUserPoolResourceServerId in interface IUserPoolResourceServer