software.amazon.awscdk.services.cognito

Class CfnUserPoolResourceServer

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.cognito.CfnUserPoolResourceServer

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:44.548Z")
 @Stability(value=Stable)
public class CfnUserPoolResourceServer
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Cognito::UserPoolResourceServer`.

The AWS::Cognito::UserPoolResourceServer resource creates a new OAuth2.0 resource server and defines custom scopes in it.

If you don't specify a value for a parameter, Amazon Cognito sets it to a default value.

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.*;
 CfnUserPoolResourceServer cfnUserPoolResourceServer = CfnUserPoolResourceServer.Builder.create(this, "MyCfnUserPoolResourceServer")
         .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	Class and Description
static class	CfnUserPoolResourceServer.Builder A fluent builder for CfnUserPoolResourceServer.
static interface	CfnUserPoolResourceServer.ResourceServerScopeTypeProperty A resource server scope.

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnUserPoolResourceServer(Construct scope, String id, CfnUserPoolResourceServerProps props) Create a new `AWS::Cognito::UserPoolResourceServer`.
protected	CfnUserPoolResourceServer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnUserPoolResourceServer(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
String	getIdentifier() A unique resource server identifier for the resource server.
String	getName() A friendly name for the resource server.
Object	getScopes() A list of scopes.
String	getUserPoolId() The user pool ID for the user pool.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setIdentifier(String value) A unique resource server identifier for the resource server.
void	setName(String value) A friendly name for the resource server.
void	setScopes(IResolvable value) A list of scopes.
void	setScopes(List<Object> value) A list of scopes.
void	setUserPoolId(String value) The user pool ID for the user pool.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnUserPoolResourceServer

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

CfnUserPoolResourceServer

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

CfnUserPoolResourceServer

@Stability(value=Stable)
public CfnUserPoolResourceServer(@NotNull
                                                          Construct scope,
                                                          @NotNull
                                                          String id,
                                                          @NotNull
                                                          CfnUserPoolResourceServerProps props)

Create a new `AWS::Cognito::UserPoolResourceServer`.

Parameters:

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

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getIdentifier

@Stability(value=Stable)
 @NotNull
public 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 .

setIdentifier

@Stability(value=Stable)
public void setIdentifier(@NotNull
                                                   String value)

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
public String getName()

A friendly name for the resource server.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

A friendly name for the resource server.

getUserPoolId

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

The user pool ID for the user pool.

setUserPoolId

@Stability(value=Stable)
public void setUserPoolId(@NotNull
                                                   String value)

The user pool ID for the user pool.

getScopes

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

A list of scopes.

Each scope is a map with keys ScopeName and ScopeDescription .

setScopes

@Stability(value=Stable)
public void setScopes(@Nullable
                                               IResolvable value)

A list of scopes.

Each scope is a map with keys ScopeName and ScopeDescription .

setScopes

@Stability(value=Stable)
public void setScopes(@Nullable
                                               List<Object> value)

A list of scopes.

Each scope is a map with keys ScopeName and ScopeDescription .