Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. cognito
  5. IdentityPoolPrincipalTag

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.cognito.IdentityPoolPrincipalTag

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::Cognito::IdentityPoolPrincipalTag

    Create IdentityPoolPrincipalTag Resource

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

    Constructor syntax

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

@overload
def IdentityPoolPrincipalTag(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             identity_pool_id: Optional[str] = None,
                             identity_provider_name: Optional[str] = None,
                             principal_tags: Optional[Any] = None,
                             use_defaults: Optional[bool] = None)
    func NewIdentityPoolPrincipalTag(ctx *Context, name string, args IdentityPoolPrincipalTagArgs, opts ...ResourceOption) (*IdentityPoolPrincipalTag, error)
    public IdentityPoolPrincipalTag(string name, IdentityPoolPrincipalTagArgs args, CustomResourceOptions? opts = null)
    public IdentityPoolPrincipalTag(String name, IdentityPoolPrincipalTagArgs args)
public IdentityPoolPrincipalTag(String name, IdentityPoolPrincipalTagArgs args, CustomResourceOptions options)

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

    Parameters

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

    IdentityPoolPrincipalTag Resource Properties

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

    Inputs

    The IdentityPoolPrincipalTag resource accepts the following input properties:

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

    Outputs

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

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

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi
    pulumi/pulumi-aws-native