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

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

AWS Native v0.101.0 published on Thursday, Apr 11, 2024 by Pulumi

aws-native.cognito.IdentityPool

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.101.0 published on Thursday, Apr 11, 2024 by Pulumi

    Resource Type definition for AWS::Cognito::IdentityPool

    Create IdentityPool Resource

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

    Constructor syntax

    new IdentityPool(name: string, args: IdentityPoolArgs, opts?: CustomResourceOptions);
    @overload
    def IdentityPool(resource_name: str,
                     args: IdentityPoolArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def IdentityPool(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     allow_unauthenticated_identities: Optional[bool] = None,
                     allow_classic_flow: Optional[bool] = None,
                     cognito_events: Optional[Any] = None,
                     cognito_identity_providers: Optional[Sequence[IdentityPoolCognitoIdentityProviderArgs]] = None,
                     cognito_streams: Optional[IdentityPoolCognitoStreamsArgs] = None,
                     developer_provider_name: Optional[str] = None,
                     identity_pool_name: Optional[str] = None,
                     open_id_connect_provider_arns: Optional[Sequence[str]] = None,
                     push_sync: Optional[IdentityPoolPushSyncArgs] = None,
                     saml_provider_arns: Optional[Sequence[str]] = None,
                     supported_login_providers: Optional[Any] = None)
    func NewIdentityPool(ctx *Context, name string, args IdentityPoolArgs, opts ...ResourceOption) (*IdentityPool, error)
    public IdentityPool(string name, IdentityPoolArgs args, CustomResourceOptions? opts = null)
    public IdentityPool(String name, IdentityPoolArgs args)
    public IdentityPool(String name, IdentityPoolArgs args, CustomResourceOptions options)
    
    type: aws-native:cognito:IdentityPool
    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 IdentityPoolArgs
    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 IdentityPoolArgs
    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 IdentityPoolArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IdentityPoolArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IdentityPoolArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const identityPoolResource = new aws_native.cognito.IdentityPool("identityPoolResource", {
        allowUnauthenticatedIdentities: false,
        allowClassicFlow: false,
        cognitoEvents: "any",
        cognitoIdentityProviders: [{
            clientId: "string",
            providerName: "string",
            serverSideTokenCheck: false,
        }],
        cognitoStreams: {
            roleArn: "string",
            streamName: "string",
            streamingStatus: "string",
        },
        developerProviderName: "string",
        identityPoolName: "string",
        openIdConnectProviderArns: ["string"],
        pushSync: {
            applicationArns: ["string"],
            roleArn: "string",
        },
        samlProviderArns: ["string"],
        supportedLoginProviders: "any",
    });
    
    Coming soon!
    

    IdentityPool 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 IdentityPool resource accepts the following input properties:

    AllowUnauthenticatedIdentities bool
    AllowClassicFlow bool
    CognitoEvents interface{}
    Search the CloudFormation User Guide for AWS::Cognito::IdentityPool for more information about the expected schema for this property.
    CognitoIdentityProviders []IdentityPoolCognitoIdentityProviderArgs
    CognitoStreams IdentityPoolCognitoStreamsArgs
    DeveloperProviderName string
    IdentityPoolName string
    OpenIdConnectProviderArns []string
    PushSync IdentityPoolPushSyncArgs
    SamlProviderArns []string
    SupportedLoginProviders interface{}
    Search the CloudFormation User Guide for AWS::Cognito::IdentityPool for more information about the expected schema for this property.
    allowUnauthenticatedIdentities Boolean
    allowClassicFlow Boolean
    cognitoEvents Object
    Search the CloudFormation User Guide for AWS::Cognito::IdentityPool for more information about the expected schema for this property.
    cognitoIdentityProviders List<IdentityPoolCognitoIdentityProvider>
    cognitoStreams IdentityPoolCognitoStreams
    developerProviderName String
    identityPoolName String
    openIdConnectProviderArns List<String>
    pushSync IdentityPoolPushSync
    samlProviderArns List<String>
    supportedLoginProviders Object
    Search the CloudFormation User Guide for AWS::Cognito::IdentityPool for more information about the expected schema for this property.
    allowUnauthenticatedIdentities boolean
    allowClassicFlow boolean
    cognitoEvents any
    Search the CloudFormation User Guide for AWS::Cognito::IdentityPool for more information about the expected schema for this property.
    cognitoIdentityProviders IdentityPoolCognitoIdentityProvider[]
    cognitoStreams IdentityPoolCognitoStreams
    developerProviderName string
    identityPoolName string
    openIdConnectProviderArns string[]
    pushSync IdentityPoolPushSync
    samlProviderArns string[]
    supportedLoginProviders any
    Search the CloudFormation User Guide for AWS::Cognito::IdentityPool for more information about the expected schema for this property.
    allow_unauthenticated_identities bool
    allow_classic_flow bool
    cognito_events Any
    Search the CloudFormation User Guide for AWS::Cognito::IdentityPool for more information about the expected schema for this property.
    cognito_identity_providers Sequence[IdentityPoolCognitoIdentityProviderArgs]
    cognito_streams IdentityPoolCognitoStreamsArgs
    developer_provider_name str
    identity_pool_name str
    open_id_connect_provider_arns Sequence[str]
    push_sync IdentityPoolPushSyncArgs
    saml_provider_arns Sequence[str]
    supported_login_providers Any
    Search the CloudFormation User Guide for AWS::Cognito::IdentityPool for more information about the expected schema for this property.
    allowUnauthenticatedIdentities Boolean
    allowClassicFlow Boolean
    cognitoEvents Any
    Search the CloudFormation User Guide for AWS::Cognito::IdentityPool for more information about the expected schema for this property.
    cognitoIdentityProviders List<Property Map>
    cognitoStreams Property Map
    developerProviderName String
    identityPoolName String
    openIdConnectProviderArns List<String>
    pushSync Property Map
    samlProviderArns List<String>
    supportedLoginProviders Any
    Search the CloudFormation User Guide for AWS::Cognito::IdentityPool for more information about the expected schema for this property.

    Outputs

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

    AwsId string
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    AwsId string
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    awsId String
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    awsId string
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    aws_id str
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    awsId String
    id String
    The provider-assigned unique ID for this managed resource.
    name String

    Supporting Types

    IdentityPoolCognitoIdentityProvider, IdentityPoolCognitoIdentityProviderArgs

    IdentityPoolCognitoStreams, IdentityPoolCognitoStreamsArgs

    IdentityPoolPushSync, IdentityPoolPushSyncArgs

    ApplicationArns List<string>
    RoleArn string
    ApplicationArns []string
    RoleArn string
    applicationArns List<String>
    roleArn String
    applicationArns string[]
    roleArn string
    application_arns Sequence[str]
    role_arn str
    applicationArns List<String>
    roleArn String

    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.101.0 published on Thursday, Apr 11, 2024 by Pulumi