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

interface RoleMappingRule ๐Ÿ”น

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

Represents an Identity Pool Role Attachment Role Mapping Rule.

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 role: iam.Role;
const roleMappingRule: cognito_identitypool_alpha.RoleMappingRule = {
  claim: 'claim',
  claimValue: 'claimValue',
  mappedRole: role,

  // the properties below are optional
  matchType: cognito_identitypool_alpha.RoleMappingMatchType.EQUALS,
};

Properties

NameTypeDescription
claim๐Ÿ”นstringThe key sent in the token by the federated identity provider.
claimValue๐Ÿ”นstringThe value of the claim that must be matched.
mappedRole๐Ÿ”นIRoleThe Role to be assumed when Claim Value is matched.
matchType?๐Ÿ”นRoleMappingMatchTypeHow to match with the Claim value.

claim๐Ÿ”น

Type: string

The key sent in the token by the federated identity provider.


claimValue๐Ÿ”น

Type: string

The value of the claim that must be matched.


mappedRole๐Ÿ”น

Type: IRole

The Role to be assumed when Claim Value is matched.


matchType?๐Ÿ”น

Type: RoleMappingMatchType (optional, default: RoleMappingMatchType.EQUALS)

How to match with the Claim value.