@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
153 lines • 5.31 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* The `scaleway.domain.Zone` resource allows you to create and manage Scaleway DNS zones.
*
* 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
*
* ### Create a DNS zone
*
* The following command allows you to create a DNS zone for the `test.scaleway-terraform.com` subdomain.
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const test = new scaleway.domain.Zone("test", {
* domain: "scaleway-terraform.com",
* subdomain: "test",
* });
* ```
*
* ## Import
*
* This section explains how to import a zone using the `{subdomain}.{domain}` format.
*
* ```sh
* $ pulumi import scaleway:index/domainZone:DomainZone test test.scaleway-terraform.com
* ```
*
* @deprecated scaleway.index/domainzone.DomainZone has been deprecated in favor of scaleway.domain/zone.Zone
*/
export declare class DomainZone extends pulumi.CustomResource {
/**
* Get an existing DomainZone 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?: DomainZoneState, opts?: pulumi.CustomResourceOptions): DomainZone;
/**
* Returns true if the given object is an instance of DomainZone. 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 DomainZone;
/**
* The main domain where the DNS zone will be created.
*/
readonly domain: pulumi.Output<string>;
/**
* Message.
*/
readonly message: pulumi.Output<string>;
/**
* The list of same servers for the zone.
*/
readonly ns: pulumi.Output<string[]>;
/**
* The default list of same servers for the zone.
*/
readonly nsDefaults: pulumi.Output<string[]>;
/**
* The master list of same servers for the zone.
*/
readonly nsMasters: pulumi.Output<string[]>;
/**
* `projectId`) The ID of the Project associated with the domain.
*/
readonly projectId: pulumi.Output<string>;
/**
* The status of the domain zone.
*/
readonly status: pulumi.Output<string>;
/**
* The name of the subdomain (zone name) to create within the domain.
*/
readonly subdomain: pulumi.Output<string>;
/**
* The date and time at which the DNS zone was last updated.
*/
readonly updatedAt: pulumi.Output<string>;
/**
* Create a DomainZone 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/domainzone.DomainZone has been deprecated in favor of scaleway.domain/zone.Zone */
constructor(name: string, args: DomainZoneArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering DomainZone resources.
*/
export interface DomainZoneState {
/**
* The main domain where the DNS zone will be created.
*/
domain?: pulumi.Input<string | undefined>;
/**
* Message.
*/
message?: pulumi.Input<string | undefined>;
/**
* The list of same servers for the zone.
*/
ns?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* The default list of same servers for the zone.
*/
nsDefaults?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* The master list of same servers for the zone.
*/
nsMasters?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* `projectId`) The ID of the Project associated with the domain.
*/
projectId?: pulumi.Input<string | undefined>;
/**
* The status of the domain zone.
*/
status?: pulumi.Input<string | undefined>;
/**
* The name of the subdomain (zone name) to create within the domain.
*/
subdomain?: pulumi.Input<string | undefined>;
/**
* The date and time at which the DNS zone was last updated.
*/
updatedAt?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a DomainZone resource.
*/
export interface DomainZoneArgs {
/**
* The main domain where the DNS zone will be created.
*/
domain: pulumi.Input<string>;
/**
* `projectId`) The ID of the Project associated with the domain.
*/
projectId?: pulumi.Input<string | undefined>;
/**
* The name of the subdomain (zone name) to create within the domain.
*/
subdomain: pulumi.Input<string>;
}
//# sourceMappingURL=domainZone.d.ts.map