software.amazon.awscdk.services.cognito

Interface CfnUserPoolResourceServerProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserPoolResourceServerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.646Z")
 @Stability(value=Stable)
public interface CfnUserPoolResourceServerProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnUserPoolResourceServer`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cognito.*;
 CfnUserPoolResourceServerProps cfnUserPoolResourceServerProps = CfnUserPoolResourceServerProps.builder()
         .identifier("identifier")
         .name("name")
         .userPoolId("userPoolId")
         // the properties below are optional
         .scopes(List.of(ResourceServerScopeTypeProperty.builder()
                 .scopeDescription("scopeDescription")
                 .scopeName("scopeName")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnUserPoolResourceServerProps.Builder	builder()
String	getIdentifier() A unique resource server identifier for the resource server.
String	getName() A friendly name for the resource server.
default Object	getScopes() A list of scopes.
String	getUserPoolId() The user pool ID for the user pool.

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.

This could be an HTTPS endpoint where the resource server is located. For example: https://my-weather-api.example.com .

getName

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

A friendly name for the resource server.

getUserPoolId

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

The user pool ID for the user pool.

getScopes

@Stability(value=Stable)
 @Nullable
default Object getScopes()

A list of scopes.

Each scope is a map with keys ScopeName and ScopeDescription .

builder

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

Returns:

a CfnUserPoolResourceServerProps.Builder of CfnUserPoolResourceServerProps