software.amazon.awscdk.services.cognito

Class CfnIdentityPoolRoleAttachment

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.cognito.CfnIdentityPoolRoleAttachment

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:44.468Z")
 @Stability(value=Stable)
public class CfnIdentityPoolRoleAttachment
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Cognito::IdentityPoolRoleAttachment`.

The AWS::Cognito::IdentityPoolRoleAttachment resource manages the role configuration for an Amazon Cognito identity pool.

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.*;
 Object roles;
 CfnIdentityPoolRoleAttachment cfnIdentityPoolRoleAttachment = CfnIdentityPoolRoleAttachment.Builder.create(this, "MyCfnIdentityPoolRoleAttachment")
         .identityPoolId("identityPoolId")
         // the properties below are optional
         .roleMappings(Map.of(
                 "roleMappingsKey", RoleMappingProperty.builder()
                         .type("type")
                         // the properties below are optional
                         .ambiguousRoleResolution("ambiguousRoleResolution")
                         .identityProvider("identityProvider")
                         .rulesConfiguration(RulesConfigurationTypeProperty.builder()
                                 .rules(List.of(MappingRuleProperty.builder()
                                         .claim("claim")
                                         .matchType("matchType")
                                         .roleArn("roleArn")
                                         .value("value")
                                         .build()))
                                 .build())
                         .build()))
         .roles(roles)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnIdentityPoolRoleAttachment.Builder A fluent builder for CfnIdentityPoolRoleAttachment.
static interface	CfnIdentityPoolRoleAttachment.MappingRuleProperty Defines how to map a claim to a role ARN.
static interface	CfnIdentityPoolRoleAttachment.RoleMappingProperty `RoleMapping` is a property of the [AWS::Cognito::IdentityPoolRoleAttachment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolroleattachment.html) resource that defines the role-mapping attributes of an Amazon Cognito identity pool.
static interface	CfnIdentityPoolRoleAttachment.RulesConfigurationTypeProperty `RulesConfigurationType` is a subproperty of the [RoleMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-rolemapping.html) property that defines the rules to be used for mapping users to roles.

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnIdentityPoolRoleAttachment(Construct scope, String id, CfnIdentityPoolRoleAttachmentProps props) Create a new `AWS::Cognito::IdentityPoolRoleAttachment`.
protected	CfnIdentityPoolRoleAttachment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnIdentityPoolRoleAttachment(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
String	getIdentityPoolId() An identity pool ID in the format `REGION:GUID` .
Object	getRoleMappings() How users for a specific identity provider are mapped to roles.
Object	getRoles() The map of the roles associated with this pool.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setIdentityPoolId(String value) An identity pool ID in the format `REGION:GUID` .
void	setRoleMappings(IResolvable value) How users for a specific identity provider are mapped to roles.
void	setRoleMappings(Map<String,Object> value) How users for a specific identity provider are mapped to roles.
void	setRoles(Object value) The map of the roles associated with this pool.

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

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

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

getRef

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

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

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

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

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.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnIdentityPoolRoleAttachment

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

CfnIdentityPoolRoleAttachment

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

CfnIdentityPoolRoleAttachment

@Stability(value=Stable)
public CfnIdentityPoolRoleAttachment(@NotNull
                                                              Construct scope,
                                                              @NotNull
                                                              String id,
                                                              @NotNull
                                                              CfnIdentityPoolRoleAttachmentProps props)

Create a new `AWS::Cognito::IdentityPoolRoleAttachment`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getIdentityPoolId

@Stability(value=Stable)
 @NotNull
public String getIdentityPoolId()

An identity pool ID in the format `REGION:GUID` .

setIdentityPoolId

@Stability(value=Stable)
public void setIdentityPoolId(@NotNull
                                                       String value)

An identity pool ID in the format `REGION:GUID` .

getRoles

@Stability(value=Stable)
 @NotNull
public Object getRoles()

The map of the roles associated with this pool.

For a given role, the key is either "authenticated" or "unauthenticated". The value is the role ARN.

setRoles

@Stability(value=Stable)
public void setRoles(@NotNull
                                              Object value)

The map of the roles associated with this pool.

For a given role, the key is either "authenticated" or "unauthenticated". The value is the role ARN.

getRoleMappings

@Stability(value=Stable)
 @Nullable
public Object getRoleMappings()

How users for a specific identity provider are mapped to roles.

This is a string to the RoleMapping object map. The string identifies the identity provider. For example: graph.facebook.com or cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id .

If the IdentityProvider field isn't provided in this object, the string is used as the identity provider name.

For more information, see the RoleMapping property .

setRoleMappings

@Stability(value=Stable)
public void setRoleMappings(@Nullable
                                                     IResolvable value)

How users for a specific identity provider are mapped to roles.

This is a string to the RoleMapping object map. The string identifies the identity provider. For example: graph.facebook.com or cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id .

If the IdentityProvider field isn't provided in this object, the string is used as the identity provider name.

For more information, see the RoleMapping property .

setRoleMappings

@Stability(value=Stable)
public void setRoleMappings(@Nullable
                                                     Map<String,Object> value)

How users for a specific identity provider are mapped to roles.

This is a string to the RoleMapping object map. The string identifies the identity provider. For example: graph.facebook.com or cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id .

If the IdentityProvider field isn't provided in this object, the string is used as the identity provider name.

For more information, see the RoleMapping property .