UserPoolResourceServerProps Struct
Properties for the UserPoolResourceServer construct.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cognito as cognito } from 'aws-cdk-lib';
import { aws_cognito as interfaces_cognito } from 'aws-cdk-lib/interfaces';
declare const resourceServerScope: cognito.ResourceServerScope;
declare const userPoolRef: interfaces_cognito.IUserPoolRef;
const userPoolResourceServerProps: cognito.UserPoolResourceServerProps = {
identifier: 'identifier',
userPool: userPoolRef,
// the properties below are optional
scopes: [resourceServerScope],
userPoolResourceServerName: 'userPoolResourceServerName',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_cognito as cognito
from aws_cdk.interfaces import aws_cognito as interfaces_cognito
# resource_server_scope: cognito.ResourceServerScope
# user_pool_ref: interfaces_cognito.IUserPoolRef
user_pool_resource_server_props = cognito.UserPoolResourceServerProps(
identifier="identifier",
user_pool=user_pool_ref,
# the properties below are optional
scopes=[resource_server_scope],
user_pool_resource_server_name="userPoolResourceServerName"
)
java
// 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.*;
import software.amazon.awscdk.interfaces.cognito.*;
ResourceServerScope resourceServerScope;
IUserPoolRef userPoolRef;
UserPoolResourceServerProps userPoolResourceServerProps = UserPoolResourceServerProps.builder()
.identifier("identifier")
.userPool(userPoolRef)
// the properties below are optional
.scopes(List.of(resourceServerScope))
.userPoolResourceServerName("userPoolResourceServerName")
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Cognito;
using Amazon.CDK.Interfaces.Cognito;
ResourceServerScope resourceServerScope;
IUserPoolRef userPoolRef;
var userPoolResourceServerProps = new UserPoolResourceServerProps {
Identifier = "identifier",
UserPool = userPoolRef,
// the properties below are optional
Scopes = new [] { resourceServerScope },
UserPoolResourceServerName = "userPoolResourceServerName"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
var resourceServerScope ResourceServerScope
var userPoolRef IUserPoolRef
userPoolResourceServerProps := &UserPoolResourceServerProps{
Identifier: jsii.String("identifier"),
UserPool: userPoolRef,
// the properties below are optional
Scopes: []ResourceServerScope{
resourceServerScope,
},
UserPoolResourceServerName: jsii.String("userPoolResourceServerName"),
}
Properties
A unique resource server identifier for the resource server.
scopesoptionalResourceServerScope[]scopesoptionaltyping.List[ResourceServerScope]scopesoptionalList<ResourceServerScope>ScopesoptionalResourceServerScope[]Scopesoptional*[]ResourceServerScope#Oauth scopes.
Default: No scopes will be added
userPoolIUserPoolRefuser_poolIUserPoolRefuserPoolIUserPoolRefUserPoolIUserPoolRefUserPoolIUserPoolRefrequired#The user pool to add this resource server to.
userPoolResourceServerNameoptionalstringuser_pool_resource_server_nameoptionalstruserPoolResourceServerNameoptionalStringUserPoolResourceServerNameoptionalstringUserPoolResourceServerNameoptional*string#A friendly name for the resource server.
Default: same as identifier