Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. cognito
  5. getIdentityPool

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
pulumi/pulumi-aws-native

aws-native.cognito.getIdentityPool

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
pulumi/pulumi-aws-native

    Resource Type definition for AWS::Cognito::IdentityPool

    Using getIdentityPool

    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 getIdentityPool(args: GetIdentityPoolArgs, opts?: InvokeOptions): Promise<GetIdentityPoolResult>
function getIdentityPoolOutput(args: GetIdentityPoolOutputArgs, opts?: InvokeOptions): Output<GetIdentityPoolResult>
    def get_identity_pool(id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetIdentityPoolResult
def get_identity_pool_output(id: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetIdentityPoolResult]
    func LookupIdentityPool(ctx *Context, args *LookupIdentityPoolArgs, opts ...InvokeOption) (*LookupIdentityPoolResult, error)
func LookupIdentityPoolOutput(ctx *Context, args *LookupIdentityPoolOutputArgs, opts ...InvokeOption) LookupIdentityPoolResultOutput

    > Note: This function is named LookupIdentityPool in the Go SDK.

    public static class GetIdentityPool 
{
    public static Task<GetIdentityPoolResult> InvokeAsync(GetIdentityPoolArgs args, InvokeOptions? opts = null)
    public static Output<GetIdentityPoolResult> Invoke(GetIdentityPoolInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetIdentityPoolResult> getIdentityPool(GetIdentityPoolArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:cognito:getIdentityPool
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    Id string
    id String
    id string
    id str
    id String

    getIdentityPool Result

    The following output properties are available:

    AllowClassicFlow bool
    Enables the Basic (Classic) authentication flow.
    AllowUnauthenticatedIdentities bool
    Specifies whether the identity pool supports unauthenticated logins.
    CognitoIdentityProviders List<Pulumi.AwsNative.Cognito.Outputs.IdentityPoolCognitoIdentityProvider>
    The Amazon Cognito user pools and their client IDs.
    DeveloperProviderName string

    The "domain" Amazon Cognito uses when referencing your users. This name acts as a placeholder that allows your backend and the Amazon Cognito service to communicate about the developer provider. For the DeveloperProviderName , you can use letters and periods (.), underscores (_), and dashes (-).

    Minimum length : 1

    Maximum length : 100

    Id string
    IdentityPoolName string

    The name of your Amazon Cognito identity pool.

    Minimum length : 1

    Maximum length : 128

    Pattern : [\w\s+=,.@-]+

    IdentityPoolTags List<Pulumi.AwsNative.Outputs.Tag>
    An array of key-value pairs to apply to this resource.
    Name string
    The name of the Amazon Cognito identity pool, returned as a string.
    OpenIdConnectProviderArns List<string>
    The Amazon Resource Names (ARNs) of the OpenID connect providers.
    SamlProviderArns List<string>
    The Amazon Resource Names (ARNs) of the Security Assertion Markup Language (SAML) providers.
    SupportedLoginProviders object

    Key-value pairs that map provider names to provider app IDs.

    Search the CloudFormation User Guide for AWS::Cognito::IdentityPool for more information about the expected schema for this property.

    AllowClassicFlow bool
    Enables the Basic (Classic) authentication flow.
    AllowUnauthenticatedIdentities bool
    Specifies whether the identity pool supports unauthenticated logins.
    CognitoIdentityProviders []IdentityPoolCognitoIdentityProvider
    The Amazon Cognito user pools and their client IDs.
    DeveloperProviderName string

    The "domain" Amazon Cognito uses when referencing your users. This name acts as a placeholder that allows your backend and the Amazon Cognito service to communicate about the developer provider. For the DeveloperProviderName , you can use letters and periods (.), underscores (_), and dashes (-).

    Minimum length : 1

    Maximum length : 100

    Id string
    IdentityPoolName string

    The name of your Amazon Cognito identity pool.

    Minimum length : 1

    Maximum length : 128

    Pattern : [\w\s+=,.@-]+

    IdentityPoolTags Tag
    An array of key-value pairs to apply to this resource.
    Name string
    The name of the Amazon Cognito identity pool, returned as a string.
    OpenIdConnectProviderArns []string
    The Amazon Resource Names (ARNs) of the OpenID connect providers.
    SamlProviderArns []string
    The Amazon Resource Names (ARNs) of the Security Assertion Markup Language (SAML) providers.
    SupportedLoginProviders interface{}

    Key-value pairs that map provider names to provider app IDs.

    Search the CloudFormation User Guide for AWS::Cognito::IdentityPool for more information about the expected schema for this property.

    allowClassicFlow Boolean
    Enables the Basic (Classic) authentication flow.
    allowUnauthenticatedIdentities Boolean
    Specifies whether the identity pool supports unauthenticated logins.
    cognitoIdentityProviders List<IdentityPoolCognitoIdentityProvider>
    The Amazon Cognito user pools and their client IDs.
    developerProviderName String

    The "domain" Amazon Cognito uses when referencing your users. This name acts as a placeholder that allows your backend and the Amazon Cognito service to communicate about the developer provider. For the DeveloperProviderName , you can use letters and periods (.), underscores (_), and dashes (-).

    Minimum length : 1

    Maximum length : 100

    id String
    identityPoolName String

    The name of your Amazon Cognito identity pool.

    Minimum length : 1

    Maximum length : 128

    Pattern : [\w\s+=,.@-]+

    identityPoolTags List<Tag>
    An array of key-value pairs to apply to this resource.
    name String
    The name of the Amazon Cognito identity pool, returned as a string.
    openIdConnectProviderArns List<String>
    The Amazon Resource Names (ARNs) of the OpenID connect providers.
    samlProviderArns List<String>
    The Amazon Resource Names (ARNs) of the Security Assertion Markup Language (SAML) providers.
    supportedLoginProviders Object

    Key-value pairs that map provider names to provider app IDs.

    Search the CloudFormation User Guide for AWS::Cognito::IdentityPool for more information about the expected schema for this property.

    allowClassicFlow boolean
    Enables the Basic (Classic) authentication flow.
    allowUnauthenticatedIdentities boolean
    Specifies whether the identity pool supports unauthenticated logins.
    cognitoIdentityProviders IdentityPoolCognitoIdentityProvider[]
    The Amazon Cognito user pools and their client IDs.
    developerProviderName string

    The "domain" Amazon Cognito uses when referencing your users. This name acts as a placeholder that allows your backend and the Amazon Cognito service to communicate about the developer provider. For the DeveloperProviderName , you can use letters and periods (.), underscores (_), and dashes (-).

    Minimum length : 1

    Maximum length : 100

    id string
    identityPoolName string

    The name of your Amazon Cognito identity pool.

    Minimum length : 1

    Maximum length : 128

    Pattern : [\w\s+=,.@-]+

    identityPoolTags Tag[]
    An array of key-value pairs to apply to this resource.
    name string
    The name of the Amazon Cognito identity pool, returned as a string.
    openIdConnectProviderArns string[]
    The Amazon Resource Names (ARNs) of the OpenID connect providers.
    samlProviderArns string[]
    The Amazon Resource Names (ARNs) of the Security Assertion Markup Language (SAML) providers.
    supportedLoginProviders any

    Key-value pairs that map provider names to provider app IDs.

    Search the CloudFormation User Guide for AWS::Cognito::IdentityPool for more information about the expected schema for this property.

    allow_classic_flow bool
    Enables the Basic (Classic) authentication flow.
    allow_unauthenticated_identities bool
    Specifies whether the identity pool supports unauthenticated logins.
    cognito_identity_providers Sequence[IdentityPoolCognitoIdentityProvider]
    The Amazon Cognito user pools and their client IDs.
    developer_provider_name str

    The "domain" Amazon Cognito uses when referencing your users. This name acts as a placeholder that allows your backend and the Amazon Cognito service to communicate about the developer provider. For the DeveloperProviderName , you can use letters and periods (.), underscores (_), and dashes (-).

    Minimum length : 1

    Maximum length : 100

    id str
    identity_pool_name str

    The name of your Amazon Cognito identity pool.

    Minimum length : 1

    Maximum length : 128

    Pattern : [\w\s+=,.@-]+

    identity_pool_tags Sequence[root_Tag]
    An array of key-value pairs to apply to this resource.
    name str
    The name of the Amazon Cognito identity pool, returned as a string.
    open_id_connect_provider_arns Sequence[str]
    The Amazon Resource Names (ARNs) of the OpenID connect providers.
    saml_provider_arns Sequence[str]
    The Amazon Resource Names (ARNs) of the Security Assertion Markup Language (SAML) providers.
    supported_login_providers Any

    Key-value pairs that map provider names to provider app IDs.

    Search the CloudFormation User Guide for AWS::Cognito::IdentityPool for more information about the expected schema for this property.

    allowClassicFlow Boolean
    Enables the Basic (Classic) authentication flow.
    allowUnauthenticatedIdentities Boolean
    Specifies whether the identity pool supports unauthenticated logins.
    cognitoIdentityProviders List<Property Map>
    The Amazon Cognito user pools and their client IDs.
    developerProviderName String

    The "domain" Amazon Cognito uses when referencing your users. This name acts as a placeholder that allows your backend and the Amazon Cognito service to communicate about the developer provider. For the DeveloperProviderName , you can use letters and periods (.), underscores (_), and dashes (-).

    Minimum length : 1

    Maximum length : 100

    id String
    identityPoolName String

    The name of your Amazon Cognito identity pool.

    Minimum length : 1

    Maximum length : 128

    Pattern : [\w\s+=,.@-]+

    identityPoolTags List<Property Map>
    An array of key-value pairs to apply to this resource.
    name String
    The name of the Amazon Cognito identity pool, returned as a string.
    openIdConnectProviderArns List<String>
    The Amazon Resource Names (ARNs) of the OpenID connect providers.
    samlProviderArns List<String>
    The Amazon Resource Names (ARNs) of the Security Assertion Markup Language (SAML) providers.
    supportedLoginProviders Any

    Key-value pairs that map provider names to provider app IDs.

    Search the CloudFormation User Guide for AWS::Cognito::IdentityPool for more information about the expected schema for this property.

    Supporting Types

    IdentityPoolCognitoIdentityProvider

    ClientId string
    The client ID for the Amazon Cognito user pool.
    ProviderName string
    The provider name for an Amazon Cognito user pool. For example: cognito-idp.us-east-2.amazonaws.com/us-east-2_123456789 .
    ServerSideTokenCheck bool

    TRUE if server-side token validation is enabled for the identity provider’s token.

    After you set the ServerSideTokenCheck to TRUE for an identity pool, that identity pool checks with the integrated user pools to make sure the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user.

    If the user is signed out or deleted, the identity pool returns a 400 Not Authorized error.

    ClientId string
    The client ID for the Amazon Cognito user pool.
    ProviderName string
    The provider name for an Amazon Cognito user pool. For example: cognito-idp.us-east-2.amazonaws.com/us-east-2_123456789 .
    ServerSideTokenCheck bool

    TRUE if server-side token validation is enabled for the identity provider’s token.

    After you set the ServerSideTokenCheck to TRUE for an identity pool, that identity pool checks with the integrated user pools to make sure the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user.

    If the user is signed out or deleted, the identity pool returns a 400 Not Authorized error.

    clientId String
    The client ID for the Amazon Cognito user pool.
    providerName String
    The provider name for an Amazon Cognito user pool. For example: cognito-idp.us-east-2.amazonaws.com/us-east-2_123456789 .
    serverSideTokenCheck Boolean

    TRUE if server-side token validation is enabled for the identity provider’s token.

    After you set the ServerSideTokenCheck to TRUE for an identity pool, that identity pool checks with the integrated user pools to make sure the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user.

    If the user is signed out or deleted, the identity pool returns a 400 Not Authorized error.

    clientId string
    The client ID for the Amazon Cognito user pool.
    providerName string
    The provider name for an Amazon Cognito user pool. For example: cognito-idp.us-east-2.amazonaws.com/us-east-2_123456789 .
    serverSideTokenCheck boolean

    TRUE if server-side token validation is enabled for the identity provider’s token.

    After you set the ServerSideTokenCheck to TRUE for an identity pool, that identity pool checks with the integrated user pools to make sure the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user.

    If the user is signed out or deleted, the identity pool returns a 400 Not Authorized error.

    client_id str
    The client ID for the Amazon Cognito user pool.
    provider_name str
    The provider name for an Amazon Cognito user pool. For example: cognito-idp.us-east-2.amazonaws.com/us-east-2_123456789 .
    server_side_token_check bool

    TRUE if server-side token validation is enabled for the identity provider’s token.

    After you set the ServerSideTokenCheck to TRUE for an identity pool, that identity pool checks with the integrated user pools to make sure the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user.

    If the user is signed out or deleted, the identity pool returns a 400 Not Authorized error.

    clientId String
    The client ID for the Amazon Cognito user pool.
    providerName String
    The provider name for an Amazon Cognito user pool. For example: cognito-idp.us-east-2.amazonaws.com/us-east-2_123456789 .
    serverSideTokenCheck Boolean

    TRUE if server-side token validation is enabled for the identity provider’s token.

    After you set the ServerSideTokenCheck to TRUE for an identity pool, that identity pool checks with the integrated user pools to make sure the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user.

    If the user is signed out or deleted, the identity pool returns a 400 Not Authorized error.

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    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
    pulumi/pulumi-aws-native