IdentityPoolRoleAttachment

class aws_cdk.aws_cognito_identitypool.IdentityPoolRoleAttachment(scope, id, *, identity_pool, authenticated_role=None, role_mappings=None, unauthenticated_role=None)

Bases: Resource

(experimental) Defines an Identity Pool Role Attachment.

Stability:

experimental

Resource:

AWS::Cognito::IdentityPoolRoleAttachment

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_identitypool as cognito_identitypool
import aws_cdk.aws_iam as iam

# identity_pool: cognito_identitypool.IdentityPool
# identity_pool_provider_url: cognito_identitypool.IdentityPoolProviderUrl
# role: iam.Role

identity_pool_role_attachment = cognito_identitypool.IdentityPoolRoleAttachment(self, "MyIdentityPoolRoleAttachment",
    identity_pool=identity_pool,

    # the properties below are optional
    authenticated_role=role,
    role_mappings=[cognito_identitypool.IdentityPoolRoleMapping(
        provider_url=identity_pool_provider_url,

        # the properties below are optional
        resolve_ambiguous_roles=False,
        rules=[cognito_identitypool.RoleMappingRule(
            claim="claim",
            claim_value="claimValue",
            mapped_role=role,

            # the properties below are optional
            match_type=cognito_identitypool.RoleMappingMatchType.EQUALS
        )],
        use_token=False
    )],
    unauthenticated_role=role
)

Parameters:

• scope (Construct)

• id (str)

• identity_pool (IIdentityPool) – (experimental) Id of the Attachments Underlying Identity Pool.

• authenticated_role (Optional[IRole]) – (experimental) Default Authenticated (User) Role. Default: - No default authenticated role will be added

• role_mappings (Optional[Sequence[Union[IdentityPoolRoleMapping, Dict[str, Any]]]]) – (experimental) Rules for mapping roles to users. Default: - no Role Mappings

• unauthenticated_role (Optional[IRole]) – (experimental) Default Unauthenticated (Guest) Role. Default: - No default unauthenticated role will be added

Stability:

experimental

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.

identity_pool_id

(experimental) Id of the underlying identity pool.

Stability:

experimental

node

The construct tree node associated with this construct.

stack

The stack in which this resource is defined.

Static Methods

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