Package software.amazon.awscdk.services.cognito.identitypool

Interface IdentityPoolRoleAttachmentProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IdentityPoolRoleAttachmentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:45.474Z")
@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.*;
 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
                 .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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static IdentityPoolRoleAttachmentProps.Builder	builder()
default IRole	getAuthenticatedRole()	(experimental) Default Authenticated (User) Role.
IIdentityPool	getIdentityPool()	(experimental) Id of the Attachments Underlying Identity Pool.
default List<IdentityPoolRoleMapping>	getRoleMappings()	(experimental) Rules for mapping roles to users.
default IRole	getUnauthenticatedRole()	(experimental) Default Unauthenticated (Guest) Role.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getIdentityPool

@Stability(Experimental)
@NotNull
IIdentityPool getIdentityPool()

(experimental) Id of the Attachments 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