import * as pulumi from "@pulumi/pulumi"; /** * Manages a Static Web App Custom Domain. * * !> **Note:** DNS validation polling is only done for CNAME records, terraform will not validate TXT validation records are complete. * * ## Example Usage * * ### CNAME validation * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as azure from "@pulumi/azure"; * * const example = new azure.core.ResourceGroup("example", { * name: "example-resources", * location: "West Europe", * }); * const exampleStaticWebApp = new azure.appservice.StaticWebApp("example", { * name: "example", * resourceGroupName: example.name, * location: example.location, * }); * const exampleCNameRecord = new azure.dns.CNameRecord("example", { * name: "my-domain", * zoneName: "contoso.com", * resourceGroupName: example.name, * ttl: 300, * record: exampleStaticWebApp.defaultHostName, * }); * const exampleStaticWebAppCustomDomain = new azure.appservice.StaticWebAppCustomDomain("example", { * staticWebAppId: exampleStaticWebApp.id, * domainName: pulumi.interpolate`${exampleCNameRecord.name}.${exampleCNameRecord.zoneName}`, * validationType: "cname-delegation", * }); * ``` * * ### TXT validation * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as azure from "@pulumi/azure"; * * const example = new azure.core.ResourceGroup("example", { * name: "example-resources", * location: "West Europe", * }); * const exampleStaticWebApp = new azure.appservice.StaticWebApp("example", { * name: "example", * resourceGroupName: example.name, * location: example.location, * }); * const exampleStaticWebAppCustomDomain = new azure.appservice.StaticWebAppCustomDomain("example", { * staticWebAppId: exampleStaticWebApp.id, * domainName: "my-domain.contoso.com", * validationType: "dns-txt-token", * }); * const exampleTxtRecord = new azure.dns.TxtRecord("example", { * name: "_dnsauth.my-domain", * zoneName: "contoso.com", * resourceGroupName: example.name, * ttl: 300, * records: [{ * value: exampleStaticWebAppCustomDomain.validationToken, * }], * }); * ``` * * ## API Providers * * * This resource uses the following Azure API Providers: * * * `Microsoft.Web` - 2023-01-01 * * ## Import * * Static Site Custom Domains can be imported using the `resource id`, e.g. * * ```sh * $ pulumi import azure:appservice/staticWebAppCustomDomain:StaticWebAppCustomDomain example /subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/group1/providers/Microsoft.Web/staticSites/my-static-site1/customDomains/name.contoso.com * ``` */ export declare class StaticWebAppCustomDomain extends pulumi.CustomResource { /** * Get an existing StaticWebAppCustomDomain 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?: StaticWebAppCustomDomainState, opts?: pulumi.CustomResourceOptions): StaticWebAppCustomDomain; /** * Returns true if the given object is an instance of StaticWebAppCustomDomain. 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 StaticWebAppCustomDomain; /** * The Domain Name which should be associated with this Static Site. Changing this forces a new Static Site Custom Domain to be created. */ readonly domainName: pulumi.Output; /** * The ID of the Static Site. Changing this forces a new Static Site Custom Domain to be created. */ readonly staticWebAppId: pulumi.Output; /** * Token to be used with `dns-txt-token` validation. */ readonly validationToken: pulumi.Output; /** * One of `cname-delegation` or `dns-txt-token`. Changing this forces a new Static Site Custom Domain to be created. * * > **Note:** Apex domains must use `dns-txt-token` validation. * * > **Note:** Validation using `dns-txt-token` is performed asynchronously and Terraform does not wait for the validation process to be successful before marking the resource as created successfully. Please ensure that the appropriate TXT record is created using the `validationToken` value for this to complete out of band. */ readonly validationType: pulumi.Output; /** * Create a StaticWebAppCustomDomain 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: StaticWebAppCustomDomainArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering StaticWebAppCustomDomain resources. */ export interface StaticWebAppCustomDomainState { /** * The Domain Name which should be associated with this Static Site. Changing this forces a new Static Site Custom Domain to be created. */ domainName?: pulumi.Input; /** * The ID of the Static Site. Changing this forces a new Static Site Custom Domain to be created. */ staticWebAppId?: pulumi.Input; /** * Token to be used with `dns-txt-token` validation. */ validationToken?: pulumi.Input; /** * One of `cname-delegation` or `dns-txt-token`. Changing this forces a new Static Site Custom Domain to be created. * * > **Note:** Apex domains must use `dns-txt-token` validation. * * > **Note:** Validation using `dns-txt-token` is performed asynchronously and Terraform does not wait for the validation process to be successful before marking the resource as created successfully. Please ensure that the appropriate TXT record is created using the `validationToken` value for this to complete out of band. */ validationType?: pulumi.Input; } /** * The set of arguments for constructing a StaticWebAppCustomDomain resource. */ export interface StaticWebAppCustomDomainArgs { /** * The Domain Name which should be associated with this Static Site. Changing this forces a new Static Site Custom Domain to be created. */ domainName: pulumi.Input; /** * The ID of the Static Site. Changing this forces a new Static Site Custom Domain to be created. */ staticWebAppId: pulumi.Input; /** * One of `cname-delegation` or `dns-txt-token`. Changing this forces a new Static Site Custom Domain to be created. * * > **Note:** Apex domains must use `dns-txt-token` validation. * * > **Note:** Validation using `dns-txt-token` is performed asynchronously and Terraform does not wait for the validation process to be successful before marking the resource as created successfully. Please ensure that the appropriate TXT record is created using the `validationToken` value for this to complete out of band. */ validationType: pulumi.Input; }