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

Class IdentityPoolRoleAttachment

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.cognito.identitypool.alpha.IdentityPoolRoleAttachment

All Implemented Interfaces:

IResource, IIdentityPoolRoleAttachment, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-09-11T18:01:25.265Z")
@Stability(Experimental)
public class IdentityPoolRoleAttachment
extends Resource
implements IIdentityPoolRoleAttachment

(experimental) Defines 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;
 IdentityPoolRoleAttachment identityPoolRoleAttachment = IdentityPoolRoleAttachment.Builder.create(this, "MyIdentityPoolRoleAttachment")
         .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

Nested Classes

Modifier and Type	Class	Description
static final class	IdentityPoolRoleAttachment.Builder	(experimental) A fluent builder for IdentityPoolRoleAttachment.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.cognito.identitypool.alpha.IIdentityPoolRoleAttachment

IIdentityPoolRoleAttachment.Jsii$Default, IIdentityPoolRoleAttachment.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	IdentityPoolRoleAttachment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	IdentityPoolRoleAttachment(software.amazon.jsii.JsiiObjectRef objRef)
	IdentityPoolRoleAttachment(software.constructs.Construct scope, String id, IdentityPoolRoleAttachmentProps props)

Method Summary

Modifier and Type	Method	Description
String	getIdentityPoolId()	(experimental) Id of the underlying identity pool.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

IdentityPoolRoleAttachment

protected IdentityPoolRoleAttachment(software.amazon.jsii.JsiiObjectRef objRef)

IdentityPoolRoleAttachment

protected IdentityPoolRoleAttachment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

IdentityPoolRoleAttachment

@Stability(Experimental)
public IdentityPoolRoleAttachment(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 IdentityPoolRoleAttachmentProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

getIdentityPoolId

@Stability(Experimental)
@NotNull
public String getIdentityPoolId()

(experimental) Id of the underlying identity pool.

Specified by:

getIdentityPoolId in interface IIdentityPoolRoleAttachment