software.amazon.awscdk.services.cognito.identitypool

Class IdentityPoolRoleAttachment

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

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

All Implemented Interfaces:

IConstruct, IDependable, IResource, IIdentityPoolRoleAttachment

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-09T19:16:42.459Z")
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.*;
 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
                 .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 and Description
static class	IdentityPoolRoleAttachment.Builder (experimental) A fluent builder for IdentityPoolRoleAttachment.

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

IIdentityPoolRoleAttachment.Jsii$Default, IIdentityPoolRoleAttachment.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class software.amazon.awscdk.core.Resource

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

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

IdentityPoolRoleAttachment

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

IdentityPoolRoleAttachment

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

IdentityPoolRoleAttachment

public IdentityPoolRoleAttachment(software.constructs.Construct scope,
                                  java.lang.String id,
                                  IdentityPoolRoleAttachmentProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

getIdentityPoolId

public java.lang.String getIdentityPoolId()

(experimental) Id of the underlying identity pool.

Specified by:

getIdentityPoolId in interface IIdentityPoolRoleAttachment