Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. cognito
  5. IdentityPoolRoleAttachment

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

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.cognito.IdentityPoolRoleAttachment

Explore with Pulumi AI

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

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

Resource Type definition for AWS::Cognito::IdentityPoolRoleAttachment

Create IdentityPoolRoleAttachment Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new IdentityPoolRoleAttachment(name: string, args: IdentityPoolRoleAttachmentArgs, opts?: CustomResourceOptions);
@overload
def IdentityPoolRoleAttachment(resource_name: str,
                               args: IdentityPoolRoleAttachmentArgs,
                               opts: Optional[ResourceOptions] = None)

@overload
def IdentityPoolRoleAttachment(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               identity_pool_id: Optional[str] = None,
                               role_mappings: Optional[Mapping[str, IdentityPoolRoleAttachmentRoleMappingArgs]] = None,
                               roles: Optional[Mapping[str, str]] = None)
func NewIdentityPoolRoleAttachment(ctx *Context, name string, args IdentityPoolRoleAttachmentArgs, opts ...ResourceOption) (*IdentityPoolRoleAttachment, error)
public IdentityPoolRoleAttachment(string name, IdentityPoolRoleAttachmentArgs args, CustomResourceOptions? opts = null)
public IdentityPoolRoleAttachment(String name, IdentityPoolRoleAttachmentArgs args)
public IdentityPoolRoleAttachment(String name, IdentityPoolRoleAttachmentArgs args, CustomResourceOptions options)

type: aws-native:cognito:IdentityPoolRoleAttachment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. IdentityPoolRoleAttachmentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. IdentityPoolRoleAttachmentArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. IdentityPoolRoleAttachmentArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. IdentityPoolRoleAttachmentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. IdentityPoolRoleAttachmentArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

IdentityPoolRoleAttachment Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The IdentityPoolRoleAttachment resource accepts the following input properties:

IdentityPoolId This property is required. string
An identity pool ID in the format REGION:GUID .
RoleMappings Dictionary<string, Pulumi.AwsNative.Cognito.Inputs.IdentityPoolRoleAttachmentRoleMappingArgs>

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.
IdentityPoolId This property is required. string
An identity pool ID in the format REGION:GUID .
RoleMappings map[string]IdentityPoolRoleAttachmentRoleMappingArgs

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.
identityPoolId This property is required. String
An identity pool ID in the format REGION:GUID .
roleMappings Map<String,IdentityPoolRoleAttachmentRoleMappingArgs>

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.
identityPoolId This property is required. string
An identity pool ID in the format REGION:GUID .
roleMappings {[key: string]: IdentityPoolRoleAttachmentRoleMappingArgs}

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.
identity_pool_id This property is required. str
An identity pool ID in the format REGION:GUID .
role_mappings Mapping[str, IdentityPoolRoleAttachmentRoleMappingArgs]

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.
identityPoolId This property is required. String
An identity pool ID in the format REGION:GUID .
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.

Outputs

All input properties are implicitly available as output properties. Additionally, the IdentityPoolRoleAttachment resource produces the following output properties:

AwsId string
The resource ID.
Id string
The provider-assigned unique ID for this managed resource.
AwsId string
The resource ID.
Id string
The provider-assigned unique ID for this managed resource.
awsId String
The resource ID.
id String
The provider-assigned unique ID for this managed resource.
awsId string
The resource ID.
id string
The provider-assigned unique ID for this managed resource.
aws_id str
The resource ID.
id str
The provider-assigned unique ID for this managed resource.
awsId String
The resource ID.
id String
The provider-assigned unique ID for this managed resource.

Supporting Types

IdentityPoolRoleAttachmentMappingRule
, IdentityPoolRoleAttachmentMappingRuleArgs

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
, IdentityPoolRoleAttachmentRoleMappingArgs

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

IdentityPoolRoleAttachmentRulesConfigurationType
, IdentityPoolRoleAttachmentRulesConfigurationTypeArgs

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.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native