@pulumiverse/scaleway/functionDomain.d.ts

A Pulumi package for creating and managing Scaleway cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * The `scaleway.functions.Domain` resource allows you to create and manage domain name bindings for Scaleway [Serverless Functions](https://www.scaleway.com/en/docs/serverless/functions/).
 *
 * Refer to the Functions domain [documentation](https://www.scaleway.com/en/docs/serverless/functions/how-to/add-a-custom-domain-name-to-a-function/) and the [API documentation](https://www.scaleway.com/en/developers/api/serverless-functions/#path-domains-list-all-domain-name-bindings) for more information.
 *
 * ## Example Usage
 *
 * This command allows to bind a custom domain name to a function.
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as scaleway from "@pulumiverse/scaleway";
 *
 * const mainNamespace = new scaleway.functions.Namespace("main", {});
 * const mainFunction = new scaleway.functions.Function("main", {
 *     namespaceId: mainNamespace.id,
 *     runtime: "go118",
 *     privacy: "private",
 *     handler: "Handle",
 *     zipFile: "testfixture/gofunction.zip",
 *     deploy: true,
 * });
 * const main = new scaleway.functions.Domain("main", {
 *     functionId: mainFunction.id,
 *     hostname: "example.com",
 * }, {
 *     dependsOn: [mainFunction],
 * });
 * ```
 *
 * ## Import
 *
 * Function domain binding can be imported using `{region}/{id}`, as shown below:
 *
 * bash
 *
 * ```sh
 * $ pulumi import scaleway:index/functionDomain:FunctionDomain main fr-par/11111111-1111-1111-1111-111111111111
 * ```
 *
 * @deprecated scaleway.index/functiondomain.FunctionDomain has been deprecated in favor of scaleway.functions/domain.Domain
 */
export declare class FunctionDomain extends pulumi.CustomResource {
    /**
     * Get an existing FunctionDomain 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<pulumi.ID>, state?: FunctionDomainState, opts?: pulumi.CustomResourceOptions): FunctionDomain;
    /**
     * Returns true if the given object is an instance of FunctionDomain.  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 FunctionDomain;
    /**
     * The unique identifier of the function.
     */
    readonly functionId: pulumi.Output<string>;
    /**
     * The hostname with a CNAME record.
     *
     * We recommend you use a CNAME domain record that point to your native function `domainName` for it.
     *
     * > **Important** Updating the `functionId` or `hostname` arguments will recreate the domain.
     */
    readonly hostname: pulumi.Output<string>;
    /**
     * (Defaults to provider `region`) The region in which the domain was created.
     */
    readonly region: pulumi.Output<string>;
    /**
     * The URL used to query the function.
     */
    readonly url: pulumi.Output<string>;
    /**
     * Create a FunctionDomain 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.
     */
    /** @deprecated scaleway.index/functiondomain.FunctionDomain has been deprecated in favor of scaleway.functions/domain.Domain */
    constructor(name: string, args: FunctionDomainArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering FunctionDomain resources.
 */
export interface FunctionDomainState {
    /**
     * The unique identifier of the function.
     */
    functionId?: pulumi.Input<string>;
    /**
     * The hostname with a CNAME record.
     *
     * We recommend you use a CNAME domain record that point to your native function `domainName` for it.
     *
     * > **Important** Updating the `functionId` or `hostname` arguments will recreate the domain.
     */
    hostname?: pulumi.Input<string>;
    /**
     * (Defaults to provider `region`) The region in which the domain was created.
     */
    region?: pulumi.Input<string>;
    /**
     * The URL used to query the function.
     */
    url?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a FunctionDomain resource.
 */
export interface FunctionDomainArgs {
    /**
     * The unique identifier of the function.
     */
    functionId: pulumi.Input<string>;
    /**
     * The hostname with a CNAME record.
     *
     * We recommend you use a CNAME domain record that point to your native function `domainName` for it.
     *
     * > **Important** Updating the `functionId` or `hostname` arguments will recreate the domain.
     */
    hostname: pulumi.Input<string>;
    /**
     * (Defaults to provider `region`) The region in which the domain was created.
     */
    region?: pulumi.Input<string>;
}