CfnUserPoolResourceServerProps¶
-
class
aws_cdk.aws_cognito.
CfnUserPoolResourceServerProps
(*, identifier, name, user_pool_id, scopes=None)¶ Bases:
object
Properties for defining a
CfnUserPoolResourceServer
.- Parameters
identifier (
str
) – 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
.name (
str
) – A friendly name for the resource server.user_pool_id (
str
) – The user pool ID for the user pool.scopes (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,ResourceServerScopeTypeProperty
]],None
]) – A list of scopes. Each scope is a map with keysScopeName
andScopeDescription
.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_cognito as cognito cfn_user_pool_resource_server_props = cognito.CfnUserPoolResourceServerProps( identifier="identifier", name="name", user_pool_id="userPoolId", # the properties below are optional scopes=[cognito.CfnUserPoolResourceServer.ResourceServerScopeTypeProperty( scope_description="scopeDescription", scope_name="scopeName" )] )
Attributes
-
identifier
¶ 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
.
-
name
¶ A friendly name for the resource server.
-
scopes
¶ A list of scopes.
Each scope is a map with keys
ScopeName
andScopeDescription
.
-
user_pool_id
¶ The user pool ID for the user pool.