Package com.pulumi.aws.cognito

Class IdentityProvider

  • public class IdentityProvider
extends com.pulumi.resources.CustomResource
    Provides a Cognito User Identity Provider resource. ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.cognito.UserPool;
 import com.pulumi.aws.cognito.UserPoolArgs;
 import com.pulumi.aws.cognito.IdentityProvider;
 import com.pulumi.aws.cognito.IdentityProviderArgs;
 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 example = new UserPool("example", UserPoolArgs.builder()
             .name("example-pool")
             .autoVerifiedAttributes("email")
             .build());
 
         var exampleProvider = new IdentityProvider("exampleProvider", IdentityProviderArgs.builder()
             .userPoolId(example.id())
             .providerName("Google")
             .providerType("Google")
             .providerDetails(Map.ofEntries(
                 Map.entry("authorize_scopes", "email"),
                 Map.entry("client_id", "your client_id"),
                 Map.entry("client_secret", "your client_secret")
             ))
             .attributeMapping(Map.ofEntries(
                 Map.entry("email", "email"),
                 Map.entry("username", "sub")
             ))
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import `aws.cognito.IdentityProvider` resources using their User Pool ID and Provider Name. For example: ```sh $ pulumi import aws:cognito/identityProvider:IdentityProvider example us-west-2_abc123:CorpAD ```

    • 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.Map<java.lang.String,​java.lang.String>> attributeMapping()  
      static IdentityProvider get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, IdentityProviderState 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.util.Optional<java.util.List<java.lang.String>>> idpIdentifiers()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> providerDetails()  
      com.pulumi.core.Output<java.lang.String> providerName()  
      com.pulumi.core.Output<java.lang.String> providerType()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> userPoolId()  

      • 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

      • IdentityProvider

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

      • IdentityProvider

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

      • IdentityProvider

        public IdentityProvider​(java.lang.String name,
                        IdentityProviderArgs 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

      • attributeMapping

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> attributeMapping()
        Returns:
        The map of attribute mapping of user pool attributes. [AttributeMapping in AWS API documentation](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateIdentityProvider.html#CognitoUserPools-CreateIdentityProvider-request-AttributeMapping)

      • idpIdentifiers

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> idpIdentifiers()
        Returns:
        The list of identity providers.

      • providerDetails

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> providerDetails()
        Returns:
        The map of identity details, such as access token

      • providerName

        public com.pulumi.core.Output<java.lang.String> providerName()
        Returns:
        The provider name

      • providerType

        public com.pulumi.core.Output<java.lang.String> providerType()
        Returns:
        The provider type. [See AWS API for valid values](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateIdentityProvider.html#CognitoUserPools-CreateIdentityProvider-request-ProviderType)

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

      • userPoolId

        public com.pulumi.core.Output<java.lang.String> userPoolId()
        Returns:
        The user pool ID

      • get

        public static IdentityProvider get​(java.lang.String name,
                                   com.pulumi.core.Output<java.lang.String> id,
                                   @Nullable
                                   IdentityProviderState 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.