software.amazon.awscdk.services.cognito

Interface CfnIdentityPoolRoleAttachmentProps

All Known Implementing Classes:

CfnIdentityPoolRoleAttachmentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-29T04:32:24.405Z")
public interface CfnIdentityPoolRoleAttachmentProps

Properties for defining a `CfnIdentityPoolRoleAttachment`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cognito.*;
 Object roles;
 CfnIdentityPoolRoleAttachmentProps cfnIdentityPoolRoleAttachmentProps = CfnIdentityPoolRoleAttachmentProps.builder()
         .identityPoolId("identityPoolId")
         // the properties below are optional
         .roleMappings(Map.of(
                 "roleMappingsKey", RoleMappingProperty.builder()
                         .type("type")
                         // the properties below are optional
                         .ambiguousRoleResolution("ambiguousRoleResolution")
                         .identityProvider("identityProvider")
                         .rulesConfiguration(RulesConfigurationTypeProperty.builder()
                                 .rules(List.of(MappingRuleProperty.builder()
                                         .claim("claim")
                                         .matchType("matchType")
                                         .roleArn("roleArn")
                                         .value("value")
                                         .build()))
                                 .build())
                         .build()))
         .roles(roles)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnIdentityPoolRoleAttachmentProps.Builder A builder for CfnIdentityPoolRoleAttachmentProps
static class	CfnIdentityPoolRoleAttachmentProps.Jsii$Proxy An implementation for CfnIdentityPoolRoleAttachmentProps

Method Summary

Modifier and Type	Method and Description
static CfnIdentityPoolRoleAttachmentProps.Builder	builder()
java.lang.String	getIdentityPoolId() An identity pool ID in the format `REGION:GUID` .
default java.lang.Object	getRoleMappings() How users for a specific identity provider are mapped to roles.
default java.lang.Object	getRoles() The map of the roles associated with this pool.

Method Detail

getIdentityPoolId

java.lang.String getIdentityPoolId()

An identity pool ID in the format `REGION:GUID` .

getRoleMappings

default java.lang.Object getRoleMappings()

How users for a specific identity provider are mapped to roles.

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 .

getRoles

default java.lang.Object getRoles()

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.

builder

static CfnIdentityPoolRoleAttachmentProps.Builder builder()

Returns:

a CfnIdentityPoolRoleAttachmentProps.Builder of CfnIdentityPoolRoleAttachmentProps