software.amazon.awscdk.services.cognito

Class ResourceServerScope

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.cognito.ResourceServerScope

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:44.597Z")
 @Stability(value=Stable)
public class ResourceServerScope
extends software.amazon.jsii.JsiiObject

A scope for ResourceServer.

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	ResourceServerScope.Builder A fluent builder for ResourceServerScope.

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

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ResourceServerScope(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ResourceServerScope(software.amazon.jsii.JsiiObjectRef objRef)
	ResourceServerScope(ResourceServerScopeProps props)

Method Summary

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

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, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

ResourceServerScope

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

ResourceServerScope

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

ResourceServerScope

@Stability(value=Stable)
public ResourceServerScope(@NotNull
                                                    ResourceServerScopeProps props)

Parameters:

props - This parameter is required.

Method Detail

getScopeDescription

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

A description of the scope.

getScopeName

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

The name of the scope.