We recommend new projects start with resources from the AWS provider.
aws-native.cognito.IdentityPoolRoleAttachment
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
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:
- Identity
Pool Id This property is required. string - An identity pool ID in the format
REGION:GUID
. - Role
Mappings Dictionary<string, Pulumi.Aws Native. Cognito. Inputs. Identity Pool Role Attachment Role Mapping Args> 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
orcognito-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.
- Identity
Pool Id This property is required. string - An identity pool ID in the format
REGION:GUID
. - Role
Mappings map[string]IdentityPool Role Attachment Role Mapping Args 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
orcognito-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.
- identity
Pool Id This property is required. String - An identity pool ID in the format
REGION:GUID
. - role
Mappings Map<String,IdentityPool Role Attachment Role Mapping Args> 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
orcognito-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.
- identity
Pool Id This property is required. string - An identity pool ID in the format
REGION:GUID
. - role
Mappings {[key: string]: IdentityPool Role Attachment Role Mapping Args} 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
orcognito-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, IdentityPool Role Attachment Role Mapping Args] 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
orcognito-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.
- identity
Pool Id This property is required. String - An identity pool ID in the format
REGION:GUID
. - role
Mappings 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
orcognito-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:
Supporting Types
IdentityPoolRoleAttachmentMappingRule, IdentityPoolRoleAttachmentMappingRuleArgs
- 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
IdentityPoolRoleAttachmentRoleMapping, IdentityPoolRoleAttachmentRoleMappingArgs
- Type
This property is required. string - Ambiguous
Role stringResolution - Identity
Provider string - Rules
Configuration Pulumi.Aws Native. Cognito. Inputs. Identity Pool Role Attachment Rules Configuration Type
- Type
This property is required. string - Ambiguous
Role stringResolution - Identity
Provider string - Rules
Configuration IdentityPool Role Attachment Rules Configuration Type
- type
This property is required. String - ambiguous
Role StringResolution - identity
Provider String - rules
Configuration IdentityPool Role Attachment Rules Configuration Type
- type
This property is required. string - ambiguous
Role stringResolution - identity
Provider string - rules
Configuration IdentityPool Role Attachment Rules Configuration Type
- type
This property is required. str - ambiguous_
role_ strresolution - identity_
provider str - rules_
configuration IdentityPool Role Attachment Rules Configuration Type
- type
This property is required. String - ambiguous
Role StringResolution - identity
Provider String - rules
Configuration Property Map
IdentityPoolRoleAttachmentRulesConfigurationType, IdentityPoolRoleAttachmentRulesConfigurationTypeArgs
- Rules
This property is required. List<Pulumi.Aws Native. Cognito. Inputs. Identity Pool Role Attachment Mapping Rule>
- Rules
This property is required. []IdentityPool Role Attachment Mapping Rule
- rules
This property is required. List<IdentityPool Role Attachment Mapping Rule>
- rules
This property is required. IdentityPool Role Attachment Mapping Rule[]
- rules
This property is required. Sequence[IdentityPool Role Attachment Mapping Rule]
- 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.