UserPoolResourceServer

class aws_cdk.aws_cognito.UserPoolResourceServer(scope, id, *, user_pool, identifier, scopes=None, user_pool_resource_server_name=None)

Bases: Resource

Defines a User Pool OAuth2.0 Resource Server.

ExampleMetadata:: infused

Example:

pool = cognito.UserPool(self, "Pool")

read_only_scope = cognito.ResourceServerScope(scope_name="read", scope_description="Read-only access")
full_access_scope = cognito.ResourceServerScope(scope_name="*", scope_description="Full access")

user_server = pool.add_resource_server("ResourceServer",
    identifier="users",
    scopes=[read_only_scope, full_access_scope]
)

read_only_client = pool.add_client("read-only-client",
    # ...
    o_auth=cognito.OAuthSettings(
        # ...
        scopes=[cognito.OAuthScope.resource_server(user_server, read_only_scope)]
    )
)

full_access_client = pool.add_client("full-access-client",
    # ...
    o_auth=cognito.OAuthSettings(
        # ...
        scopes=[cognito.OAuthScope.resource_server(user_server, full_access_scope)]
    )
)

Parameters:

scope (Construct) –
id (str) –
user_pool (IUserPool) – The user pool to add this resource server to.
identifier (str) – A unique resource server identifier for the resource server.
scopes (Optional[Sequence[ResourceServerScope]]) – Oauth scopes. Default: - No scopes will be added
user_pool_resource_server_name (Optional[str]) – A friendly name for the resource server. Default: - same as identifier

Methods

apply_removal_policy(policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:

policy (RemovalPolicy) –

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str

Attributes

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

node: The construct tree node associated with this construct.

stack: The stack in which this resource is defined.

user_pool_resource_server_id: Resource server id.

Static Methods

classmethod from_user_pool_resource_server_id(scope, id, user_pool_resource_server_id)

Import a user pool resource client given its id.

Parameters:

scope (Construct) –
id (str) –
user_pool_resource_server_id (str) –

Return type:

IUserPoolResourceServer

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters:

x (Any) –

Return type:

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:

construct (IConstruct) –

Return type:

bool