Package 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.104.0 (build e79254c)",
           date="2024-11-06T23:25:06.371Z")
@Stability(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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolresourceserver.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	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 Details

getIdentifier

@Stability(Stable)
@NotNull
String getIdentifier()

A unique resource server identifier for the resource server.

The identifier can be an API friendly name like solar-system-data . You can also set an API URL like https://solar-system-data-api.example.com as your identifier.

Amazon Cognito represents scopes in the access token in the format $resource-server-identifier/$scope . Longer scope-identifier strings increase the size of your access tokens.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolresourceserver.html#cfn-cognito-userpoolresourceserver-identifier

getName

@Stability(Stable)
@NotNull
String getName()

A friendly name for the resource server.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolresourceserver.html#cfn-cognito-userpoolresourceserver-name

getUserPoolId

@Stability(Stable)
@NotNull
String getUserPoolId()

The user pool ID for the user pool.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolresourceserver.html#cfn-cognito-userpoolresourceserver-userpoolid

getScopes

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

A list of scopes.

Each scope is a map with keys ScopeName and ScopeDescription .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolresourceserver.html#cfn-cognito-userpoolresourceserver-scopes

builder

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

Returns:

a CfnUserPoolResourceServerProps.Builder of CfnUserPoolResourceServerProps