@pulumiverse/scaleway/domain/getZone.d.ts

A Pulumi package for creating and managing Scaleway cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * The `scaleway.domain.Zone` data source is used to get information about a DNS zone within a specific domain and subdomain in Scaleway Domains and DNS.
 *
 * Refer to the Domains and DNS [product documentation](https://www.scaleway.com/en/docs/network/domains-and-dns/) and [API documentation](https://www.scaleway.com/en/developers/api/domains-and-dns/) for more information.
 *
 * ## Example Usage
 *
 * ### Query a domain zone
 *
 * The following command allows you to retrieve information about the DNS zone for the subdomain `test` within the domain `scaleway-terraform.com`.
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as scaleway from "@pulumiverse/scaleway";
 *
 * // Get zone
 * const main = scaleway.domain.getZone({
 *     domain: "scaleway-terraform.com",
 *     subdomain: "test",
 * });
 * ```
 */
export declare function getZone(args?: GetZoneArgs, opts?: pulumi.InvokeOptions): Promise<GetZoneResult>;
/**
 * A collection of arguments for invoking getZone.
 */
export interface GetZoneArgs {
    /**
     * The primary domain name where the DNS zone is located. This is a mandatory field.
     */
    domain?: string;
    /**
     * ). The ID of the Scaleway Project associated with the domain. If not specified, it defaults to the `projectId` set in the provider configuration.
     */
    projectId?: string;
    /**
     * The subdomain (or zone name) within the primary domain. This is a mandatory field.
     */
    subdomain?: string;
}
/**
 * A collection of values returned by getZone.
 */
export interface GetZoneResult {
    readonly domain?: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    /**
     * Message associated with the domain zone (typically used for status or error messages).
     */
    readonly message: string;
    /**
     * The list of name servers for the zone.
     */
    readonly ns: string[];
    /**
     * The default list of name servers for the zone.
     */
    readonly nsDefaults: string[];
    /**
     * The master list of name servers for the zone.
     */
    readonly nsMasters: string[];
    readonly projectId?: string;
    /**
     * The status of the domain zone.
     */
    readonly status: string;
    readonly subdomain?: string;
    /**
     * The date and time of the last update to the DNS zone.
     */
    readonly updatedAt: string;
}
/**
 * The `scaleway.domain.Zone` data source is used to get information about a DNS zone within a specific domain and subdomain in Scaleway Domains and DNS.
 *
 * Refer to the Domains and DNS [product documentation](https://www.scaleway.com/en/docs/network/domains-and-dns/) and [API documentation](https://www.scaleway.com/en/developers/api/domains-and-dns/) for more information.
 *
 * ## Example Usage
 *
 * ### Query a domain zone
 *
 * The following command allows you to retrieve information about the DNS zone for the subdomain `test` within the domain `scaleway-terraform.com`.
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as scaleway from "@pulumiverse/scaleway";
 *
 * // Get zone
 * const main = scaleway.domain.getZone({
 *     domain: "scaleway-terraform.com",
 *     subdomain: "test",
 * });
 * ```
 */
export declare function getZoneOutput(args?: GetZoneOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetZoneResult>;
/**
 * A collection of arguments for invoking getZone.
 */
export interface GetZoneOutputArgs {
    /**
     * The primary domain name where the DNS zone is located. This is a mandatory field.
     */
    domain?: pulumi.Input<string | undefined>;
    /**
     * ). The ID of the Scaleway Project associated with the domain. If not specified, it defaults to the `projectId` set in the provider configuration.
     */
    projectId?: pulumi.Input<string | undefined>;
    /**
     * The subdomain (or zone name) within the primary domain. This is a mandatory field.
     */
    subdomain?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=getZone.d.ts.map