Add-VSCognitoIdentityPoolRoleAttachmentMappingRule
Add-VSCognitoIdentityPoolRoleAttachmentMappingRule
SYNOPSIS
Adds an AWS::Cognito::IdentityPoolRoleAttachment.MappingRule resource property to the template. Defines how to map a claim to a role ARN.
SYNTAX
Add-VSCognitoIdentityPoolRoleAttachmentMappingRule [-MatchType] <Object> [-Value] <Object> [-Claim] <Object>
[-RoleARN] <Object> [<CommonParameters>]
DESCRIPTION
Adds an AWS::Cognito::IdentityPoolRoleAttachment.MappingRule resource property to the template. Defines how to map a claim to a role ARN.
PARAMETERS
-MatchType
The match condition that specifies how closely the claim value in the IdP token must match Value. Valid values are: Equals, Contains, StartsWith, and NotEqual.
Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-mappingrule.html#cfn-cognito-identitypoolroleattachment-mappingrule-matchtype PrimitiveType: String UpdateType: Mutable
Type: Object
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Value
A brief string that the claim must match. For example, “paid” or “yes”.
Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-mappingrule.html#cfn-cognito-identitypoolroleattachment-mappingrule-value PrimitiveType: String UpdateType: Mutable
Type: Object
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Claim
The claim name that must be present in the token. For example: “isAdmin” or “paid”.
Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-mappingrule.html#cfn-cognito-identitypoolroleattachment-mappingrule-claim PrimitiveType: String UpdateType: Mutable
Type: Object
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RoleARN
The Amazon Resource Name ARN of the role.
Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-mappingrule.html#cfn-cognito-identitypoolroleattachment-mappingrule-rolearn PrimitiveType: String UpdateType: Mutable
Type: Object
Parameter Sets: (All)
Aliases:
Required: True
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.