CfnUserPoolGroupPropsMixin

class aws_cdk.cfn_property_mixins.aws_cognito.CfnUserPoolGroupPropsMixin(props, *, strategy=None)

Bases: Mixin

A user pool group.

Contains details about the group and the way that it contributes to IAM role decisions with identity pools. Identity pools can make decisions about the IAM role to assign based on groups: users get credentials for the role associated with their highest-priority group.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolgroup.html
CloudformationResource:: AWS::Cognito::UserPoolGroup
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.cfn_property_mixins import aws_cognito as cognito
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_user_pool_group_props_mixin = cognito.CfnUserPoolGroupPropsMixin(cognito.CfnUserPoolGroupMixinProps(
    description="description",
    group_name="groupName",
    precedence=123,
    role_arn="roleArn",
    user_pool_id="userPoolId"
),
    strategy=merge_strategy
)

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

Parameters:

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

Methods

apply_to(construct)

Apply the mixin properties to the construct.

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

supports(construct)

Check if this mixin supports the given construct.

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

Attributes

CFN_PROPERTY_KEYS = ['description', 'groupName', 'precedence', 'roleArn', 'userPoolId']

Static Methods

classmethod is_mixin(x)

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.