Package software.amazon.awscdk.services.cognito

Class CfnUserPoolResourceServer.Builder

java.lang.Object

software.amazon.awscdk.services.cognito.CfnUserPoolResourceServer.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnUserPoolResourceServer>

Enclosing class:

CfnUserPoolResourceServer

@Stability(Stable)
public static final class CfnUserPoolResourceServer.Builder
extends Object
implements software.amazon.jsii.Builder<CfnUserPoolResourceServer>

A fluent builder for CfnUserPoolResourceServer.

Method Summary

Modifier and Type	Method	Description
CfnUserPoolResourceServer	build()
static CfnUserPoolResourceServer.Builder	create(software.constructs.Construct scope, String id)
CfnUserPoolResourceServer.Builder	identifier(String identifier)	A unique resource server identifier for the resource server.
CfnUserPoolResourceServer.Builder	name(String name)	A friendly name for the resource server.
CfnUserPoolResourceServer.Builder	scopes(List<? extends Object> scopes)	A list of scopes.
CfnUserPoolResourceServer.Builder	scopes(IResolvable scopes)	A list of scopes.
CfnUserPoolResourceServer.Builder	userPoolId(String userPoolId)	The ID of the user pool where you want to create a resource server.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnUserPoolResourceServer.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnUserPoolResourceServer.Builder.

identifier

@Stability(Stable)
public CfnUserPoolResourceServer.Builder identifier(String identifier)

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.

Parameters:

identifier - A unique resource server identifier for the resource server. This parameter is required.

Returns:

this

See Also:

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

name

@Stability(Stable)
public CfnUserPoolResourceServer.Builder name(String name)

A friendly name for the resource server.

Parameters:

name - A friendly name for the resource server. This parameter is required.

Returns:

this

See Also:

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

userPoolId

@Stability(Stable)
public CfnUserPoolResourceServer.Builder userPoolId(String userPoolId)

The ID of the user pool where you want to create a resource server.

Parameters:

userPoolId - The ID of the user pool where you want to create a resource server. This parameter is required.

Returns:

this

See Also:

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

scopes

@Stability(Stable)
public CfnUserPoolResourceServer.Builder scopes(IResolvable scopes)

A list of scopes.

Each scope is a map with keys ScopeName and ScopeDescription .

Parameters:

scopes - A list of scopes. This parameter is required.

Returns:

this

See Also:

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

scopes

@Stability(Stable)
public CfnUserPoolResourceServer.Builder scopes(List<? extends Object> scopes)

A list of scopes.

Each scope is a map with keys ScopeName and ScopeDescription .

Parameters:

scopes - A list of scopes. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnUserPoolResourceServer build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnUserPoolResourceServer>

Returns:

a newly built instance of CfnUserPoolResourceServer.