CfnIdentityPoolRoleAttachmentProps

class aws_cdk.aws_cognito.CfnIdentityPoolRoleAttachmentProps(*, identity_pool_id, role_mappings=None, roles=None)

Bases: object

Properties for defining a AWS::Cognito::IdentityPoolRoleAttachment.

Parameters
  • identity_pool_id (str) – AWS::Cognito::IdentityPoolRoleAttachment.IdentityPoolId.

  • role_mappings (Union[IResolvable, Mapping[str, Union[IResolvable, RoleMappingProperty]], None]) – AWS::Cognito::IdentityPoolRoleAttachment.RoleMappings.

  • roles (Optional[Any]) – AWS::Cognito::IdentityPoolRoleAttachment.Roles.

Link

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

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

# roles is of type object

cfn_identity_pool_role_attachment_props = cognito.CfnIdentityPoolRoleAttachmentProps(
    identity_pool_id="identityPoolId",

    # the properties below are optional
    role_mappings={
        "role_mappings_key": cognito.CfnIdentityPoolRoleAttachment.RoleMappingProperty(
            type="type",

            # the properties below are optional
            ambiguous_role_resolution="ambiguousRoleResolution",
            identity_provider="identityProvider",
            rules_configuration=cognito.CfnIdentityPoolRoleAttachment.RulesConfigurationTypeProperty(
                rules=[cognito.CfnIdentityPoolRoleAttachment.MappingRuleProperty(
                    claim="claim",
                    match_type="matchType",
                    role_arn="roleArn",
                    value="value"
                )]
            )
        )
    },
    roles=roles
)

Attributes

identity_pool_id

AWS::Cognito::IdentityPoolRoleAttachment.IdentityPoolId.

Link

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

Return type

str

role_mappings

AWS::Cognito::IdentityPoolRoleAttachment.RoleMappings.

Link

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

Return type

Union[IResolvable, Mapping[str, Union[IResolvable, RoleMappingProperty]], None]

roles

AWS::Cognito::IdentityPoolRoleAttachment.Roles.

Link

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

Return type

Any