Interface UserPoolResourceServerOptions
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Subinterfaces:
UserPoolResourceServerProps
- All Known Implementing Classes:
UserPoolResourceServerOptions.Jsii$Proxy,UserPoolResourceServerProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
date="2025-11-13T16:10:01.629Z")
@Stability(Stable)
public interface UserPoolResourceServerOptions
extends software.amazon.jsii.JsiiSerializable
Options to create a UserPoolResourceServer.
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 ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forUserPoolResourceServerOptionsstatic final classAn implementation forUserPoolResourceServerOptions -
Method Summary
Modifier and TypeMethodDescriptionbuilder()A unique resource server identifier for the resource server.default List<ResourceServerScope> Oauth scopes.default StringA friendly name for the resource server.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getIdentifier
A unique resource server identifier for the resource server. -
getScopes
Oauth scopes.Default: - No scopes will be added
-
getUserPoolResourceServerName
A friendly name for the resource server.Default: - same as `identifier`
-
builder
-