software.amazon.awscdk.services.cognito

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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.697Z")
 @Stability(value=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 Classes

Modifier and Type	Interface and Description
static class	UserPoolResourceServerOptions.Builder A builder for UserPoolResourceServerOptions
static class	UserPoolResourceServerOptions.Jsii$Proxy An implementation for UserPoolResourceServerOptions

Method Summary

Modifier and Type	Method and Description
static UserPoolResourceServerOptions.Builder	builder()
String	getIdentifier() A unique resource server identifier for the resource server.
default List<ResourceServerScope>	getScopes() Oauth scopes.
default String	getUserPoolResourceServerName() A friendly name for the resource server.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getIdentifier

@Stability(value=Stable)
 @NotNull
String getIdentifier()

A unique resource server identifier for the resource server.

getScopes

@Stability(value=Stable)
 @Nullable
default List<ResourceServerScope> getScopes()

Oauth scopes.

Default: - No scopes will be added

getUserPoolResourceServerName

@Stability(value=Stable)
 @Nullable
default String getUserPoolResourceServerName()

A friendly name for the resource server.

Default: - same as `identifier`

builder

@Stability(value=Stable)
static UserPoolResourceServerOptions.Builder builder()

Returns:

a UserPoolResourceServerOptions.Builder of UserPoolResourceServerOptions