Package software.amazon.awscdk.services.cognito

Class CfnIdentityPoolRoleAttachment

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.cognito.CfnIdentityPoolRoleAttachment
All Implemented Interfaces:
IEnvironmentAware, IInspectable, IIdentityPoolRoleAttachmentRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-04T09:27:37.144Z") @Stability(Stable) public class CfnIdentityPoolRoleAttachment extends CfnResource implements IInspectable, IIdentityPoolRoleAttachmentRef
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();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnIdentityPoolRoleAttachment

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

    • CfnIdentityPoolRoleAttachment

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

    • CfnIdentityPoolRoleAttachment

      @Stability(Stable) public CfnIdentityPoolRoleAttachment(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnIdentityPoolRoleAttachmentProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(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(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The resource ID.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getIdentityPoolRoleAttachmentRef

      @Stability(Stable) @NotNull public IdentityPoolRoleAttachmentReference getIdentityPoolRoleAttachmentRef()
      A reference to a IdentityPoolRoleAttachment resource.
      Specified by:
      getIdentityPoolRoleAttachmentRef in interface IIdentityPoolRoleAttachmentRef

    • getIdentityPoolId

      @Stability(Stable) @NotNull public String getIdentityPoolId()
      An identity pool ID in the format REGION:GUID .

    • setIdentityPoolId

      @Stability(Stable) public void setIdentityPoolId(@NotNull String value)
      An identity pool ID in the format REGION:GUID .

    • getRoleMappings

      @Stability(Stable) @Nullable public Object getRoleMappings()
      How users for a specific identity provider are mapped to roles.

      Returns union: either IResolvable or Mapinvalid input: '<'String, either IResolvable or CfnIdentityPoolRoleAttachment.RoleMappingProperty>

    • setRoleMappings

      @Stability(Stable) public void setRoleMappings(@Nullable IResolvable value)
      How users for a specific identity provider are mapped to roles.

    • setRoleMappings

      @Stability(Stable) public void setRoleMappings(@Nullable Map<String,Object> value)
      How users for a specific identity provider are mapped to roles.

    • getRoles

      @Stability(Stable) @Nullable public Object getRoles()
      The map of the roles associated with this pool.

    • setRoles

      @Stability(Stable) public void setRoles(@Nullable Object value)
      The map of the roles associated with this pool.