CfnUserPoolResourceServerPropsMixin

class aws_cdk.mixins_preview.aws_cognito.mixins.CfnUserPoolResourceServerPropsMixin(props, *, strategy=None)

Bases: Mixin

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolresourceserver.html
CloudformationResource:: AWS::Cognito::UserPoolResourceServer
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_cognito import mixins as cognito_mixins

cfn_user_pool_resource_server_props_mixin = cognito_mixins.CfnUserPoolResourceServerPropsMixin(cognito_mixins.CfnUserPoolResourceServerMixinProps(
    identifier="identifier",
    name="name",
    scopes=[cognito_mixins.CfnUserPoolResourceServerPropsMixin.ResourceServerScopeTypeProperty(
        scope_description="scopeDescription",
        scope_name="scopeName"
    )],
    user_pool_id="userPoolId"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Cognito::UserPoolResourceServer.

Parameters:

props (Union[CfnUserPoolResourceServerMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['identifier', 'name', 'scopes', 'userPoolId']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

ResourceServerScopeTypeProperty

class CfnUserPoolResourceServerPropsMixin.ResourceServerScopeTypeProperty(*, scope_description=None, scope_name=None)

Bases: object

One custom scope associated with a user pool resource server.

This data type is a member of ResourceServerScopeType . For more information, see Scopes, M2M, and API authorization with resource servers .

Parameters:

scope_description (Optional[str]) – A friendly description of a custom scope.
scope_name (Optional[str]) – The name of the scope. Amazon Cognito renders custom scopes in the format resourceServerIdentifier/ScopeName . For example, if this parameter is exampleScope in the resource server with the identifier exampleResourceServer , you request and receive the scope exampleResourceServer/exampleScope .

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_cognito import mixins as cognito_mixins

resource_server_scope_type_property = cognito_mixins.CfnUserPoolResourceServerPropsMixin.ResourceServerScopeTypeProperty(
    scope_description="scopeDescription",
    scope_name="scopeName"
)

Attributes

scope_description

A friendly description of a custom scope.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolresourceserver-resourceserverscopetype.html#cfn-cognito-userpoolresourceserver-resourceserverscopetype-scopedescription

scope_name

The name of the scope.

Amazon Cognito renders custom scopes in the format resourceServerIdentifier/ScopeName . For example, if this parameter is exampleScope in the resource server with the identifier exampleResourceServer , you request and receive the scope exampleResourceServer/exampleScope .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolresourceserver-resourceserverscopetype.html#cfn-cognito-userpoolresourceserver-resourceserverscopetype-scopename