import * as pulumi from "@pulumi/pulumi"; import * as inputs from "./types/input"; import * as outputs from "./types/output"; /** * With Auth0, you can use a custom domain to maintain a consistent user experience. This resource allows you to create and manage a custom domain within your Auth0 tenant. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as auth0 from "@pulumi/auth0"; * * const myCustomDomain = new auth0.CustomDomain("my_custom_domain", { * domain: "auth.example.com", * type: "auth0_managed_certs", * tlsPolicy: "recommended", * domainMetadata: { * key1: "value1", * key2: "value2", * }, * }); * ``` * * ## Import * * Custom domains can be imported using their ID. * * You can find existing custom domain IDs using the Auth0 Management API. * * https://auth0.com/docs/api/management/v2#!/Custom_Domains/get_custom_domains * * Example: * * ```sh * $ pulumi import auth0:index/customDomain:CustomDomain my_custom_domain "cd_XXXXXXXXXXXXXXXX" * ``` */ export declare class CustomDomain extends pulumi.CustomResource { /** * Get an existing CustomDomain 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 Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: CustomDomainState, opts?: pulumi.CustomResourceOptions): CustomDomain; /** * Returns true if the given object is an instance of CustomDomain. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is CustomDomain; /** * The Custom Domain certificate. */ readonly certificates: pulumi.Output; /** * The HTTP header to fetch the client's IP address. Cannot be set on auth0Managed domains. */ readonly customClientIpHeader: pulumi.Output; /** * Name of the custom domain. */ readonly domain: pulumi.Output; /** * Metadata associated with the Custom Domain. Maximum of 10 metadata properties allowed. */ readonly domainMetadata: pulumi.Output<{ [key: string]: string; } | undefined>; /** * Once the configuration status is `ready`, the DNS name of the Auth0 origin server that handles traffic for the custom domain. */ readonly originDomainName: pulumi.Output; /** * Indicates whether this is a primary domain. * * @deprecated Primary field is no longer used and will be removed in a future release. */ readonly primary: pulumi.Output; /** * Configuration status for the custom domain. Options include `disabled`, `pending`, `pendingVerification`, and `ready`. */ readonly status: pulumi.Output; /** * TLS policy for the custom domain. Available options are: `compatible` or `recommended`. Compatible includes TLS 1.0, 1.1, 1.2, and recommended only includes TLS 1.2. Cannot be set on selfManaged domains. */ readonly tlsPolicy: pulumi.Output; /** * Provisioning type for the custom domain. Options include `auth0ManagedCerts` and `selfManagedCerts`. */ readonly type: pulumi.Output; /** * Configuration settings for verification. */ readonly verifications: pulumi.Output; /** * Create a CustomDomain resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: CustomDomainArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering CustomDomain resources. */ export interface CustomDomainState { /** * The Custom Domain certificate. */ certificates?: pulumi.Input[]>; /** * The HTTP header to fetch the client's IP address. Cannot be set on auth0Managed domains. */ customClientIpHeader?: pulumi.Input; /** * Name of the custom domain. */ domain?: pulumi.Input; /** * Metadata associated with the Custom Domain. Maximum of 10 metadata properties allowed. */ domainMetadata?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * Once the configuration status is `ready`, the DNS name of the Auth0 origin server that handles traffic for the custom domain. */ originDomainName?: pulumi.Input; /** * Indicates whether this is a primary domain. * * @deprecated Primary field is no longer used and will be removed in a future release. */ primary?: pulumi.Input; /** * Configuration status for the custom domain. Options include `disabled`, `pending`, `pendingVerification`, and `ready`. */ status?: pulumi.Input; /** * TLS policy for the custom domain. Available options are: `compatible` or `recommended`. Compatible includes TLS 1.0, 1.1, 1.2, and recommended only includes TLS 1.2. Cannot be set on selfManaged domains. */ tlsPolicy?: pulumi.Input; /** * Provisioning type for the custom domain. Options include `auth0ManagedCerts` and `selfManagedCerts`. */ type?: pulumi.Input; /** * Configuration settings for verification. */ verifications?: pulumi.Input[]>; } /** * The set of arguments for constructing a CustomDomain resource. */ export interface CustomDomainArgs { /** * The HTTP header to fetch the client's IP address. Cannot be set on auth0Managed domains. */ customClientIpHeader?: pulumi.Input; /** * Name of the custom domain. */ domain: pulumi.Input; /** * Metadata associated with the Custom Domain. Maximum of 10 metadata properties allowed. */ domainMetadata?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * TLS policy for the custom domain. Available options are: `compatible` or `recommended`. Compatible includes TLS 1.0, 1.1, 1.2, and recommended only includes TLS 1.2. Cannot be set on selfManaged domains. */ tlsPolicy?: pulumi.Input; /** * Provisioning type for the custom domain. Options include `auth0ManagedCerts` and `selfManagedCerts`. */ type: pulumi.Input; }