1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. cognito
  5. getIdentityPoolRoleAttachment

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi

aws-native.cognito.getIdentityPoolRoleAttachment

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi

Resource Type definition for AWS::Cognito::IdentityPoolRoleAttachment

Using getIdentityPoolRoleAttachment

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getIdentityPoolRoleAttachment(args: GetIdentityPoolRoleAttachmentArgs, opts?: InvokeOptions): Promise<GetIdentityPoolRoleAttachmentResult>
function getIdentityPoolRoleAttachmentOutput(args: GetIdentityPoolRoleAttachmentOutputArgs, opts?: InvokeOptions): Output<GetIdentityPoolRoleAttachmentResult>
Copy
def get_identity_pool_role_attachment(id: Optional[str] = None,
                                      opts: Optional[InvokeOptions] = None) -> GetIdentityPoolRoleAttachmentResult
def get_identity_pool_role_attachment_output(id: Optional[pulumi.Input[str]] = None,
                                      opts: Optional[InvokeOptions] = None) -> Output[GetIdentityPoolRoleAttachmentResult]
Copy
func LookupIdentityPoolRoleAttachment(ctx *Context, args *LookupIdentityPoolRoleAttachmentArgs, opts ...InvokeOption) (*LookupIdentityPoolRoleAttachmentResult, error)
func LookupIdentityPoolRoleAttachmentOutput(ctx *Context, args *LookupIdentityPoolRoleAttachmentOutputArgs, opts ...InvokeOption) LookupIdentityPoolRoleAttachmentResultOutput
Copy

> Note: This function is named LookupIdentityPoolRoleAttachment in the Go SDK.

public static class GetIdentityPoolRoleAttachment 
{
    public static Task<GetIdentityPoolRoleAttachmentResult> InvokeAsync(GetIdentityPoolRoleAttachmentArgs args, InvokeOptions? opts = null)
    public static Output<GetIdentityPoolRoleAttachmentResult> Invoke(GetIdentityPoolRoleAttachmentInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetIdentityPoolRoleAttachmentResult> getIdentityPoolRoleAttachment(GetIdentityPoolRoleAttachmentArgs args, InvokeOptions options)
public static Output<GetIdentityPoolRoleAttachmentResult> getIdentityPoolRoleAttachment(GetIdentityPoolRoleAttachmentArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:cognito:getIdentityPoolRoleAttachment
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Id This property is required. string
The resource ID.
Id This property is required. string
The resource ID.
id This property is required. String
The resource ID.
id This property is required. string
The resource ID.
id This property is required. str
The resource ID.
id This property is required. String
The resource ID.

getIdentityPoolRoleAttachment Result

The following output properties are available:

Id string
The resource ID.
RoleMappings Dictionary<string, Pulumi.AwsNative.Cognito.Outputs.IdentityPoolRoleAttachmentRoleMapping>

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 .

Roles Dictionary<string, string>
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.
Id string
The resource ID.
RoleMappings map[string]IdentityPoolRoleAttachmentRoleMapping

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 .

Roles map[string]string
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.
id String
The resource ID.
roleMappings Map<String,IdentityPoolRoleAttachmentRoleMapping>

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 .

roles Map<String,String>
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.
id string
The resource ID.
roleMappings {[key: string]: IdentityPoolRoleAttachmentRoleMapping}

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 .

roles {[key: string]: string}
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.
id str
The resource ID.
role_mappings Mapping[str, IdentityPoolRoleAttachmentRoleMapping]

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 .

roles Mapping[str, str]
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.
id String
The resource ID.
roleMappings Map<Property Map>

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 .

roles Map<String>
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.

Supporting Types

IdentityPoolRoleAttachmentMappingRule

Claim This property is required. string
MatchType This property is required. string
RoleArn This property is required. string
Value This property is required. string
Claim This property is required. string
MatchType This property is required. string
RoleArn This property is required. string
Value This property is required. string
claim This property is required. String
matchType This property is required. String
roleArn This property is required. String
value This property is required. String
claim This property is required. string
matchType This property is required. string
roleArn This property is required. string
value This property is required. string
claim This property is required. str
match_type This property is required. str
role_arn This property is required. str
value This property is required. str
claim This property is required. String
matchType This property is required. String
roleArn This property is required. String
value This property is required. String

IdentityPoolRoleAttachmentRoleMapping

type This property is required. String
ambiguousRoleResolution String
identityProvider String
rulesConfiguration Property Map

IdentityPoolRoleAttachmentRulesConfigurationType

rules This property is required. List<Property Map>

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi