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, Dict[str, Any]]], None]) – A list of scopes. Each scope is a map with keys ScopeName and ScopeDescription .

Link

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

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 .

Link

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

Return type

str

name

A friendly name for the resource server.

Link

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

Return type

str

scopes

A list of scopes.

Each scope is a map with keys ScopeName and ScopeDescription .

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, ResourceServerScopeTypeProperty]], None]

user_pool_id

The user pool ID for the user pool.

Link

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

Return type

str