CfnIdentityPoolRoleAttachmentProps Struct
Properties for defining a CfnIdentityPoolRoleAttachment.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cognito as cognito } from 'aws-cdk-lib';
declare const roles: any;
const cfnIdentityPoolRoleAttachmentProps: cognito.CfnIdentityPoolRoleAttachmentProps = {
identityPoolId: 'identityPoolId',
// the properties below are optional
roleMappings: {
roleMappingsKey: {
type: 'type',
// the properties below are optional
ambiguousRoleResolution: 'ambiguousRoleResolution',
identityProvider: 'identityProvider',
rulesConfiguration: {
rules: [{
claim: 'claim',
matchType: 'matchType',
roleArn: 'roleArn',
value: 'value',
}],
},
},
},
roles: roles,
};
Properties
identityPoolIdstring | IIdentityPoolRefidentity_pool_idtyping.Union[str, IIdentityPoolRef]identityPoolIdStringIdentityPoolIdstringIdentityPoolIdinterface{}required#An identity pool ID in the format `REGION:GUID` .
roleMappingsIResolvable | { [key: string]: IResolvable | CfnIdentityPoolRoleAttachment.RoleMappingProperty }role_mappingstyping.Union[IResolvable, typing.Mapping[str, typing.Union[IResolvable, RoleMappingProperty]]]roleMappingsIResolvableRoleMappingsIResolvableRoleMappingsinterface{}#How users for a specific identity provider are mapped to roles.
notes
This is a string to the RoleMapping object map. The string identifies the identity provider. For example: graph.facebook.com or cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id .
If the IdentityProvider field isn't provided in this object, the string is used as the identity provider name.
For more information, see the RoleMapping property .
The map of the roles associated with this pool.
For a given role, the key is either "authenticated" or "unauthenticated". The value is the role ARN.