Package software.amazon.awscdk.services.cognito

Interface CfnUserPoolResourceServer.ResourceServerScopeTypeProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserPoolResourceServer.ResourceServerScopeTypeProperty.Jsii$Proxy

Enclosing class:

CfnUserPoolResourceServer

@Stability(Stable)
public static interface CfnUserPoolResourceServer.ResourceServerScopeTypeProperty
extends software.amazon.jsii.JsiiSerializable

One custom scope associated with a user pool resource server.

This data type is a member of ResourceServerScopeType . For more information, see Scopes, M2M, and API authorization with resource servers .

This data type is a request parameter of CreateResourceServer and a response parameter of DescribeResourceServer .

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.*;
 ResourceServerScopeTypeProperty resourceServerScopeTypeProperty = ResourceServerScopeTypeProperty.builder()
         .scopeDescription("scopeDescription")
         .scopeName("scopeName")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnUserPoolResourceServer.ResourceServerScopeTypeProperty.Builder	builder()
String	getScopeDescription()	A friendly description of a custom scope.
String	getScopeName()	The name of the scope.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getScopeDescription

@Stability(Stable)
@NotNull
String getScopeDescription()

A friendly description of a custom scope.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolresourceserver-resourceserverscopetype.html#cfn-cognito-userpoolresourceserver-resourceserverscopetype-scopedescription

getScopeName

@Stability(Stable)
@NotNull
String getScopeName()

The name of the scope.

Amazon Cognito renders custom scopes in the format resourceServerIdentifier/ScopeName . For example, if this parameter is exampleScope in the resource server with the identifier exampleResourceServer , you request and receive the scope exampleResourceServer/exampleScope .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolresourceserver-resourceserverscopetype.html#cfn-cognito-userpoolresourceserver-resourceserverscopetype-scopename

builder

@Stability(Stable)
static CfnUserPoolResourceServer.ResourceServerScopeTypeProperty.Builder builder()

Returns:

a CfnUserPoolResourceServer.ResourceServerScopeTypeProperty.Builder of CfnUserPoolResourceServer.ResourceServerScopeTypeProperty