@aws-cdk_aws-cognito-identitypool-alpha.IdentityPoolRoleAttachmentProps

interface IdentityPoolRoleAttachmentProps ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Cognito.IdentityPool.Alpha.IdentityPoolRoleAttachmentProps
Gogithub.com/aws/aws-cdk-go/awscdkcognitoidentitypoolalpha/v2#IdentityPoolRoleAttachmentProps
Javasoftware.amazon.awscdk.services.cognito.identitypool.alpha.IdentityPoolRoleAttachmentProps
Pythonaws_cdk.aws_cognito_identitypool_alpha.IdentityPoolRoleAttachmentProps
TypeScript (source)@aws-cdk/aws-cognito-identitypool-alpha ยป IdentityPoolRoleAttachmentProps

Props for an Identity Pool Role Attachment.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cognito_identitypool_alpha from '@aws-cdk/aws-cognito-identitypool-alpha';
import { aws_iam as iam } from 'aws-cdk-lib';

declare const identityPool: cognito_identitypool_alpha.IdentityPool;
declare const identityPoolProviderUrl: cognito_identitypool_alpha.IdentityPoolProviderUrl;
declare const role: iam.Role;
const identityPoolRoleAttachmentProps: cognito_identitypool_alpha.IdentityPoolRoleAttachmentProps = {
  identityPool: identityPool,

  // the properties below are optional
  authenticatedRole: role,
  roleMappings: [{
    providerUrl: identityPoolProviderUrl,

    // the properties below are optional
    mappingKey: 'mappingKey',
    resolveAmbiguousRoles: false,
    rules: [{
      claim: 'claim',
      claimValue: 'claimValue',
      mappedRole: role,

      // the properties below are optional
      matchType: cognito_identitypool_alpha.RoleMappingMatchType.EQUALS,
    }],
    useToken: false,
  }],
  unauthenticatedRole: role,
};

Properties

NameTypeDescription
identityPool๐Ÿ”นIIdentityPoolId of the Attachments Underlying Identity Pool.
authenticatedRole?๐Ÿ”นIRoleDefault Authenticated (User) Role.
roleMappings?๐Ÿ”นIdentityPoolRoleMapping[]Rules for mapping roles to users.
unauthenticatedRole?๐Ÿ”นIRoleDefault Unauthenticated (Guest) Role.

identityPool๐Ÿ”น

Type: IIdentityPool

Id of the Attachments Underlying Identity Pool.


authenticatedRole?๐Ÿ”น

Type: IRole (optional, default: No default authenticated role will be added)

Default Authenticated (User) Role.


roleMappings?๐Ÿ”น

Type: IdentityPoolRoleMapping[] (optional, default: no Role Mappings)

Rules for mapping roles to users.


unauthenticatedRole?๐Ÿ”น

Type: IRole (optional, default: No default unauthenticated role will be added)

Default Unauthenticated (Guest) Role.