Package com.pulumi.aws.cognito

Class IdentityPool

  • public class IdentityPool
extends com.pulumi.resources.CustomResource
    Provides an AWS Cognito Identity Pool. ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.iam.SamlProvider;
 import com.pulumi.aws.iam.SamlProviderArgs;
 import com.pulumi.std.StdFunctions;
 import com.pulumi.std.inputs.FileArgs;
 import com.pulumi.aws.cognito.IdentityPool;
 import com.pulumi.aws.cognito.IdentityPoolArgs;
 import com.pulumi.aws.cognito.inputs.IdentityPoolCognitoIdentityProviderArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var default_ = new SamlProvider("default", SamlProviderArgs.builder()
             .name("my-saml-provider")
             .samlMetadataDocument(StdFunctions.file(FileArgs.builder()
                 .input("saml-metadata.xml")
                 .build()).result())
             .build());
 
         var main = new IdentityPool("main", IdentityPoolArgs.builder()
             .cognitoIdentityProviders(            
                 IdentityPoolCognitoIdentityProviderArgs.builder()
                     .clientId("6lhlkkfbfb4q5kpp90urffae")
                     .providerName("cognito-idp.us-east-1.amazonaws.com/us-east-1_Tv0493apJ")
                     .serverSideTokenCheck(false)
                     .build(),
                 IdentityPoolCognitoIdentityProviderArgs.builder()
                     .clientId("7kodkvfqfb4qfkp39eurffae")
                     .providerName("cognito-idp.us-east-1.amazonaws.com/eu-west-1_Zr231apJu")
                     .serverSideTokenCheck(false)
                     .build())
             .identityPoolName("identity pool")
             .allowUnauthenticatedIdentities(false)
             .allowClassicFlow(false)
             .supportedLoginProviders(Map.ofEntries(
                 Map.entry("graph.facebook.com", "7346241598935552"),
                 Map.entry("accounts.google.com", "123456789012.apps.googleusercontent.com")
             ))
             .samlProviderArns(default_.arn())
             .openidConnectProviderArns("arn:aws:iam::123456789012:oidc-provider/id.example.com")
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import Cognito Identity Pool using its ID. For example: ```sh $ pulumi import aws:cognito/identityPool:IdentityPool mypool us-west-2:1a234567-8901-234b-5cde-f6789g01h2i3 ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> allowClassicFlow()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> allowUnauthenticatedIdentities()  
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<IdentityPoolCognitoIdentityProvider>>> cognitoIdentityProviders()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> developerProviderName()  
      static IdentityPool get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, IdentityPoolState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> identityPoolName()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> openidConnectProviderArns()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> samlProviderArns()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> supportedLoginProviders()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • IdentityPool

        public IdentityPool​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • IdentityPool

        public IdentityPool​(java.lang.String name,
                    IdentityPoolArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • IdentityPool

        public IdentityPool​(java.lang.String name,
                    IdentityPoolArgs args,
                    @Nullable
                    com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • allowClassicFlow

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> allowClassicFlow()
        Returns:
        Enables or disables the classic / basic authentication flow. Default is `false`.

      • allowUnauthenticatedIdentities

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> allowUnauthenticatedIdentities()
        Returns:
        Whether the identity pool supports unauthenticated logins or not.

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        The ARN of the identity pool.

      • cognitoIdentityProviders

        public com.pulumi.core.Output<java.util.Optional<java.util.List<IdentityPoolCognitoIdentityProvider>>> cognitoIdentityProviders()
        Returns:
        An array of Amazon Cognito Identity user pools and their client IDs.

      • developerProviderName

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> developerProviderName()
        Returns:
        The "domain" by which Cognito will refer to your users. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider.

      • identityPoolName

        public com.pulumi.core.Output<java.lang.String> identityPoolName()
        Returns:
        The Cognito Identity Pool name.

      • openidConnectProviderArns

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> openidConnectProviderArns()
        Returns:
        Set of OpendID Connect provider ARNs.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • samlProviderArns

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> samlProviderArns()
        Returns:
        An array of ARNs of the SAML provider for your identity.

      • supportedLoginProviders

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> supportedLoginProviders()
        Returns:
        Key-Value pairs mapping provider names to provider app IDs.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        A map of tags to assign to the Identity Pool. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • get

        public static IdentityPool get​(java.lang.String name,
                               com.pulumi.core.Output<java.lang.String> id,
                               @Nullable
                               IdentityPoolState state,
                               @Nullable
                               com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.