software.amazon.awscdk.services.cognito

Interface CfnIdentityPoolRoleAttachmentProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIdentityPoolRoleAttachmentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:44.473Z")
 @Stability(value=Stable)
public interface CfnIdentityPoolRoleAttachmentProps
extends software.amazon.jsii.JsiiSerializable

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()
String	getIdentityPoolId() An identity pool ID in the format `REGION:GUID` .
default Object	getRoleMappings() How users for a specific identity provider are mapped to roles.
default Object	getRoles() The map of the roles associated with this pool.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getIdentityPoolId

@Stability(value=Stable)
 @NotNull
String getIdentityPoolId()

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

getRoleMappings

@Stability(value=Stable)
 @Nullable
default 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

@Stability(value=Stable)
 @Nullable
default 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

@Stability(value=Stable)
static CfnIdentityPoolRoleAttachmentProps.Builder builder()

Returns:

a CfnIdentityPoolRoleAttachmentProps.Builder of CfnIdentityPoolRoleAttachmentProps