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();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forIdentityPoolRoleAttachmentProps
static final class
An implementation forIdentityPoolRoleAttachmentProps
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default IRole
(experimental) Default authenticated (User) Role.(experimental) ID of the Attachment's underlying Identity Pool.default List<IdentityPoolRoleMapping>
(experimental) Rules for mapping roles to users.default IRole
(experimental) Default unauthenticated (Guest) Role.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getIdentityPool
(experimental) ID of the Attachment's underlying Identity Pool. -
getAuthenticatedRole
(experimental) Default authenticated (User) Role.Default: - No default authenticated Role will be added
-
getRoleMappings
(experimental) Rules for mapping roles to users.Default: - No role mappings
-
getUnauthenticatedRole
(experimental) Default unauthenticated (Guest) Role.Default: - No default unauthenticated Role will be added
-
builder
-