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

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

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

aws-native.cognito.getIdentityPoolPrincipalTag

Explore with Pulumi AI

aws-native logo

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

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

    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:

    IdentityPoolId string
    The identity pool that you want to associate with this principal tag map.
    IdentityProviderName string
    The identity pool identity provider (IdP) that you want to associate with this principal tag map.
    IdentityPoolId string
    The identity pool that you want to associate with this principal tag map.
    IdentityProviderName string
    The identity pool identity provider (IdP) that you want to associate with this principal tag map.
    identityPoolId String
    The identity pool that you want to associate with this principal tag map.
    identityProviderName String
    The identity pool identity provider (IdP) that you want to associate with this principal tag map.
    identityPoolId string
    The identity pool that you want to associate with this principal tag map.
    identityProviderName string
    The identity pool identity provider (IdP) that you want to associate with this principal tag map.
    identity_pool_id str
    The identity pool that you want to associate with this principal tag map.
    identity_provider_name str
    The identity pool identity provider (IdP) that you want to associate with this principal tag map.
    identityPoolId String
    The identity pool that you want to associate with this principal tag map.
    identityProviderName String
    The identity pool identity provider (IdP) that you want to associate with this principal tag map.

    getIdentityPoolPrincipalTag Result

    The following output properties are available:

    PrincipalTags 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.

    UseDefaults bool
    Use a default set of mappings between claims and tags for this provider, instead of a custom map.
    PrincipalTags 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.

    UseDefaults bool
    Use a default set of mappings between claims and tags for this provider, instead of a custom map.
    principalTags 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.

    useDefaults Boolean
    Use a default set of mappings between claims and tags for this provider, instead of a custom map.
    principalTags 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.

    useDefaults boolean
    Use a default set of mappings between claims and tags for this provider, instead of a custom map.
    principal_tags 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.
    principalTags 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.

    useDefaults 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
    aws-native logo

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

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi