Package 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:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:43.858Z") @Stability(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();

  • 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 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 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.

    • getCfnProperties

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

    • 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 .

    • getRoles

      @Stability(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(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(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(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(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 .