software.amazon.awscdk.services.cognito

Interface ResourceServerScopeProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ResourceServerScopeProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:44.598Z")
 @Stability(value=Stable)
public interface ResourceServerScopeProps
extends software.amazon.jsii.JsiiSerializable

Props to initialize ResourceServerScope.

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	ResourceServerScopeProps.Builder A builder for ResourceServerScopeProps
static class	ResourceServerScopeProps.Jsii$Proxy An implementation for ResourceServerScopeProps

Method Summary

Modifier and Type	Method and Description
static ResourceServerScopeProps.Builder	builder()
String	getScopeDescription() A description of the scope.
String	getScopeName() The name of the scope.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getScopeDescription

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

A description of the scope.

getScopeName

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

The name of the scope.

builder

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

Returns:

a ResourceServerScopeProps.Builder of ResourceServerScopeProps