com.pulumi.aws.cognito.UserPoolDomain Maven / Gradle / Ivy
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.aws.cognito;
import com.pulumi.aws.Utilities;
import com.pulumi.aws.cognito.UserPoolDomainArgs;
import com.pulumi.aws.cognito.inputs.UserPoolDomainState;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import java.lang.String;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* Provides a Cognito User Pool Domain resource.
*
* ## Example Usage
*
* ### Amazon Cognito domain
*
* <!--Start PulumiCodeChooser -->
*
* {@code
* 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 -->
*
* {@code
* 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
* ```
*
*/
@ResourceType(type="aws:cognito/userPoolDomain:UserPoolDomain")
public class UserPoolDomain extends com.pulumi.resources.CustomResource {
/**
* The AWS account ID for the user pool owner.
*
*/
@Export(name="awsAccountId", refs={String.class}, tree="[0]")
private Output awsAccountId;
/**
* @return The AWS account ID for the user pool owner.
*
*/
public Output awsAccountId() {
return this.awsAccountId;
}
/**
* The ARN of an ISSUED ACM certificate in us-east-1 for a custom domain.
*
*/
@Export(name="certificateArn", refs={String.class}, tree="[0]")
private Output certificateArn;
/**
* @return The ARN of an ISSUED ACM certificate in us-east-1 for a custom domain.
*
*/
public Output> certificateArn() {
return Codegen.optional(this.certificateArn);
}
/**
* 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.
*
*/
@Export(name="cloudfrontDistribution", refs={String.class}, tree="[0]")
private Output cloudfrontDistribution;
/**
* @return 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.
*
*/
public Output cloudfrontDistribution() {
return this.cloudfrontDistribution;
}
/**
* The URL of the CloudFront distribution. This is required to generate the ALIAS `aws.route53.Record`
*
*/
@Export(name="cloudfrontDistributionArn", refs={String.class}, tree="[0]")
private Output cloudfrontDistributionArn;
/**
* @return The URL of the CloudFront distribution. This is required to generate the ALIAS `aws.route53.Record`
*
*/
public Output cloudfrontDistributionArn() {
return this.cloudfrontDistributionArn;
}
/**
* The Route 53 hosted zone ID of the CloudFront distribution.
*
*/
@Export(name="cloudfrontDistributionZoneId", refs={String.class}, tree="[0]")
private Output cloudfrontDistributionZoneId;
/**
* @return The Route 53 hosted zone ID of the CloudFront distribution.
*
*/
public Output cloudfrontDistributionZoneId() {
return this.cloudfrontDistributionZoneId;
}
/**
* 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.
*
*/
@Export(name="domain", refs={String.class}, tree="[0]")
private Output domain;
/**
* @return 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.
*
*/
public Output domain() {
return this.domain;
}
/**
* The S3 bucket where the static files for this domain are stored.
*
*/
@Export(name="s3Bucket", refs={String.class}, tree="[0]")
private Output s3Bucket;
/**
* @return The S3 bucket where the static files for this domain are stored.
*
*/
public Output s3Bucket() {
return this.s3Bucket;
}
/**
* The user pool ID.
*
*/
@Export(name="userPoolId", refs={String.class}, tree="[0]")
private Output userPoolId;
/**
* @return The user pool ID.
*
*/
public Output userPoolId() {
return this.userPoolId;
}
/**
* The app version.
*
*/
@Export(name="version", refs={String.class}, tree="[0]")
private Output version;
/**
* @return The app version.
*
*/
public Output version() {
return this.version;
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public UserPoolDomain(java.lang.String name) {
this(name, UserPoolDomainArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public UserPoolDomain(java.lang.String name, UserPoolDomainArgs args) {
this(name, args, null);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
* @param options A bag of options that control this resource's behavior.
*/
public UserPoolDomain(java.lang.String name, UserPoolDomainArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("aws:cognito/userPoolDomain:UserPoolDomain", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private UserPoolDomain(java.lang.String name, Output id, @Nullable UserPoolDomainState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("aws:cognito/userPoolDomain:UserPoolDomain", name, state, makeResourceOptions(options, id), false);
}
private static UserPoolDomainArgs makeArgs(UserPoolDomainArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? UserPoolDomainArgs.Empty : args;
}
private static com.pulumi.resources.CustomResourceOptions makeResourceOptions(@Nullable com.pulumi.resources.CustomResourceOptions options, @Nullable Output id) {
var defaultOptions = com.pulumi.resources.CustomResourceOptions.builder()
.version(Utilities.getVersion())
.build();
return com.pulumi.resources.CustomResourceOptions.merge(defaultOptions, options, id);
}
/**
* Get an existing Host resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state
* @param options Optional settings to control the behavior of the CustomResource.
*/
public static UserPoolDomain get(java.lang.String name, Output id, @Nullable UserPoolDomainState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new UserPoolDomain(name, id, state, options);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy