Interface IdentityPoolRoleAttachmentProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
IdentityPoolRoleAttachmentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-12-11T23:26:43.012Z") @Stability(Experimental) public interface IdentityPoolRoleAttachmentProps extends software.amazon.jsii.JsiiSerializable
(experimental) 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 software.amazon.awscdk.services.cognito.identitypool.alpha.*;
 import software.amazon.awscdk.services.iam.*;
 IdentityPool identityPool;
 IdentityPoolProviderUrl identityPoolProviderUrl;
 Role role;
 IdentityPoolRoleAttachmentProps identityPoolRoleAttachmentProps = IdentityPoolRoleAttachmentProps.builder()
         .identityPool(identityPool)
         // the properties below are optional
         .authenticatedRole(role)
         .roleMappings(List.of(IdentityPoolRoleMapping.builder()
                 .providerUrl(identityPoolProviderUrl)
                 // the properties below are optional
                 .mappingKey("mappingKey")
                 .resolveAmbiguousRoles(false)
                 .rules(List.of(RoleMappingRule.builder()
                         .claim("claim")
                         .claimValue("claimValue")
                         .mappedRole(role)
                         // the properties below are optional
                         .matchType(RoleMappingMatchType.EQUALS)
                         .build()))
                 .useToken(false)
                 .build()))
         .unauthenticatedRole(role)
         .build();
 
  • Method Details

    • getIdentityPool

      @Stability(Experimental) @NotNull IIdentityPool getIdentityPool()
      (experimental) ID of the Attachment's underlying Identity Pool.
    • getAuthenticatedRole

      @Stability(Experimental) @Nullable default IRole getAuthenticatedRole()
      (experimental) Default authenticated (User) Role.

      Default: - No default authenticated Role will be added

    • getRoleMappings

      @Stability(Experimental) @Nullable default List<IdentityPoolRoleMapping> getRoleMappings()
      (experimental) Rules for mapping roles to users.

      Default: - No role mappings

    • getUnauthenticatedRole

      @Stability(Experimental) @Nullable default IRole getUnauthenticatedRole()
      (experimental) Default unauthenticated (Guest) Role.

      Default: - No default unauthenticated Role will be added

    • builder

      @Stability(Experimental) static IdentityPoolRoleAttachmentProps.Builder builder()
      Returns:
      a IdentityPoolRoleAttachmentProps.Builder of IdentityPoolRoleAttachmentProps