Package com.pulumi.aws.cognito

Class UserPoolDomain

  • public class UserPoolDomain
extends com.pulumi.resources.CustomResource
    Provides a Cognito User Pool Domain resource. ## Example Usage ### Amazon Cognito domain <!--Start PulumiCodeChooser --> 
     
 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.UserPoolDomain;
 import com.pulumi.aws.cognito.UserPoolDomainArgs;
 import java.util.List;
 import java.util.ArrayList;
 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")
             .build());
 
         var main = new UserPoolDomain("main", UserPoolDomainArgs.builder()        
             .domain("example-domain")
             .userPoolId(example.id())
             .build());
 
     }
 }
    <!--End PulumiCodeChooser --> ### Custom Cognito domain <!--Start PulumiCodeChooser --> 
     
 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.UserPoolDomain;
 import com.pulumi.aws.cognito.UserPoolDomainArgs;
 import com.pulumi.aws.route53.Route53Functions;
 import com.pulumi.aws.route53.inputs.GetZoneArgs;
 import com.pulumi.aws.route53.Record;
 import com.pulumi.aws.route53.RecordArgs;
 import com.pulumi.aws.route53.inputs.RecordAliasArgs;
 import java.util.List;
 import java.util.ArrayList;
 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 exampleUserPool = new UserPool("exampleUserPool", UserPoolArgs.builder()        
             .name("example-pool")
             .build());
 
         var main = new UserPoolDomain("main", UserPoolDomainArgs.builder()        
             .domain("example-domain")
             .certificateArn(cert.arn())
             .userPoolId(exampleUserPool.id())
             .build());
 
         final var example = Route53Functions.getZone(GetZoneArgs.builder()
             .name("example.com")
             .build());
 
         var auth_cognito_A = new Record("auth-cognito-A", RecordArgs.builder()        
             .name(main.domain())
             .type("A")
             .zoneId(example.applyValue(getZoneResult -> getZoneResult.zoneId()))
             .aliases(RecordAliasArgs.builder()
                 .evaluateTargetHealth(false)
                 .name(main.cloudfrontDistribution())
                 .zoneId(main.cloudfrontDistributionZoneId())
                 .build())
             .build());
 
     }
 }
    <!--End PulumiCodeChooser --> ## Import Using `pulumi import`, import Cognito User Pool Domains using the `domain`. For example: ```sh $ pulumi import aws:cognito/userPoolDomain:UserPoolDomain main auth.example.org ```

    • 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.lang.String> awsAccountId()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> certificateArn()  
      com.pulumi.core.Output<java.lang.String> cloudfrontDistribution()  
      com.pulumi.core.Output<java.lang.String> cloudfrontDistributionArn()  
      com.pulumi.core.Output<java.lang.String> cloudfrontDistributionZoneId()  
      com.pulumi.core.Output<java.lang.String> domain()  
      static UserPoolDomain get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, UserPoolDomainState 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> s3Bucket()  
      com.pulumi.core.Output<java.lang.String> userPoolId()  
      com.pulumi.core.Output<java.lang.String> version()  

      • 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

      • UserPoolDomain

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

      • UserPoolDomain

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

      • UserPoolDomain

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

      • awsAccountId

        public com.pulumi.core.Output<java.lang.String> awsAccountId()
        Returns:
        The AWS account ID for the user pool owner.

      • certificateArn

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> certificateArn()
        Returns:
        The ARN of an ISSUED ACM certificate in us-east-1 for a custom domain.

      • cloudfrontDistribution

        public com.pulumi.core.Output<java.lang.String> cloudfrontDistribution()
        Returns:
        The Amazon CloudFront endpoint (e.g. `dpp0gtxikpq3y.cloudfront.net`) that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.

      • cloudfrontDistributionArn

        public com.pulumi.core.Output<java.lang.String> cloudfrontDistributionArn()
        Returns:
        The URL of the CloudFront distribution. This is required to generate the ALIAS `aws.route53.Record`

      • cloudfrontDistributionZoneId

        public com.pulumi.core.Output<java.lang.String> cloudfrontDistributionZoneId()
        Returns:
        The Route 53 hosted zone ID of the CloudFront distribution.

      • domain

        public com.pulumi.core.Output<java.lang.String> domain()
        Returns:
        For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.

      • s3Bucket

        public com.pulumi.core.Output<java.lang.String> s3Bucket()
        Returns:
        The S3 bucket where the static files for this domain are stored.

      • userPoolId

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

      • version

        public com.pulumi.core.Output<java.lang.String> version()
        Returns:
        The app version.

      • get

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