We recommend new projects start with resources from the AWS provider.
aws-native.cognito.getIdentityPoolPrincipalTag
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
Resource Type definition for AWS::Cognito::IdentityPoolPrincipalTag
Using getIdentityPoolPrincipalTag
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 getIdentityPoolPrincipalTag(args: GetIdentityPoolPrincipalTagArgs, opts?: InvokeOptions): Promise<GetIdentityPoolPrincipalTagResult>
function getIdentityPoolPrincipalTagOutput(args: GetIdentityPoolPrincipalTagOutputArgs, opts?: InvokeOptions): Output<GetIdentityPoolPrincipalTagResult>
def get_identity_pool_principal_tag(identity_pool_id: Optional[str] = None,
identity_provider_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetIdentityPoolPrincipalTagResult
def get_identity_pool_principal_tag_output(identity_pool_id: Optional[pulumi.Input[str]] = None,
identity_provider_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetIdentityPoolPrincipalTagResult]
func LookupIdentityPoolPrincipalTag(ctx *Context, args *LookupIdentityPoolPrincipalTagArgs, opts ...InvokeOption) (*LookupIdentityPoolPrincipalTagResult, error)
func LookupIdentityPoolPrincipalTagOutput(ctx *Context, args *LookupIdentityPoolPrincipalTagOutputArgs, opts ...InvokeOption) LookupIdentityPoolPrincipalTagResultOutput
> Note: This function is named LookupIdentityPoolPrincipalTag
in the Go SDK.
public static class GetIdentityPoolPrincipalTag
{
public static Task<GetIdentityPoolPrincipalTagResult> InvokeAsync(GetIdentityPoolPrincipalTagArgs args, InvokeOptions? opts = null)
public static Output<GetIdentityPoolPrincipalTagResult> Invoke(GetIdentityPoolPrincipalTagInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetIdentityPoolPrincipalTagResult> getIdentityPoolPrincipalTag(GetIdentityPoolPrincipalTagArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws-native:cognito:getIdentityPoolPrincipalTag
arguments:
# arguments dictionary
The following arguments are supported:
- Identity
Pool stringId - The identity pool that you want to associate with this principal tag map.
- Identity
Provider stringName - The identity pool identity provider (IdP) that you want to associate with this principal tag map.
- Identity
Pool stringId - The identity pool that you want to associate with this principal tag map.
- Identity
Provider stringName - The identity pool identity provider (IdP) that you want to associate with this principal tag map.
- identity
Pool StringId - The identity pool that you want to associate with this principal tag map.
- identity
Provider StringName - The identity pool identity provider (IdP) that you want to associate with this principal tag map.
- identity
Pool stringId - The identity pool that you want to associate with this principal tag map.
- identity
Provider stringName - The identity pool identity provider (IdP) that you want to associate with this principal tag map.
- identity_
pool_ strid - The identity pool that you want to associate with this principal tag map.
- identity_
provider_ strname - The identity pool identity provider (IdP) that you want to associate with this principal tag map.
- identity
Pool StringId - The identity pool that you want to associate with this principal tag map.
- identity
Provider StringName - The identity pool identity provider (IdP) that you want to associate with this principal tag map.
getIdentityPoolPrincipalTag Result
The following output properties are available:
- object
A JSON-formatted list of user claims and the principal tags that you want to associate with them. When Amazon Cognito requests credentials, it sets the value of the principal tag to the value of the user's claim.
Search the CloudFormation User Guide for
AWS::Cognito::IdentityPoolPrincipalTag
for more information about the expected schema for this property.- Use
Defaults bool - Use a default set of mappings between claims and tags for this provider, instead of a custom map.
- interface{}
A JSON-formatted list of user claims and the principal tags that you want to associate with them. When Amazon Cognito requests credentials, it sets the value of the principal tag to the value of the user's claim.
Search the CloudFormation User Guide for
AWS::Cognito::IdentityPoolPrincipalTag
for more information about the expected schema for this property.- Use
Defaults bool - Use a default set of mappings between claims and tags for this provider, instead of a custom map.
- Object
A JSON-formatted list of user claims and the principal tags that you want to associate with them. When Amazon Cognito requests credentials, it sets the value of the principal tag to the value of the user's claim.
Search the CloudFormation User Guide for
AWS::Cognito::IdentityPoolPrincipalTag
for more information about the expected schema for this property.- use
Defaults Boolean - Use a default set of mappings between claims and tags for this provider, instead of a custom map.
- any
A JSON-formatted list of user claims and the principal tags that you want to associate with them. When Amazon Cognito requests credentials, it sets the value of the principal tag to the value of the user's claim.
Search the CloudFormation User Guide for
AWS::Cognito::IdentityPoolPrincipalTag
for more information about the expected schema for this property.- use
Defaults boolean - Use a default set of mappings between claims and tags for this provider, instead of a custom map.
- Any
A JSON-formatted list of user claims and the principal tags that you want to associate with them. When Amazon Cognito requests credentials, it sets the value of the principal tag to the value of the user's claim.
Search the CloudFormation User Guide for
AWS::Cognito::IdentityPoolPrincipalTag
for more information about the expected schema for this property.- use_
defaults bool - Use a default set of mappings between claims and tags for this provider, instead of a custom map.
- Any
A JSON-formatted list of user claims and the principal tags that you want to associate with them. When Amazon Cognito requests credentials, it sets the value of the principal tag to the value of the user's claim.
Search the CloudFormation User Guide for
AWS::Cognito::IdentityPoolPrincipalTag
for more information about the expected schema for this property.- use
Defaults Boolean - Use a default set of mappings between claims and tags for this provider, instead of a custom 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.