@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
268 lines (267 loc) • 8.27 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Creates and manages Scaleway Web Hostings.
* For more information, see the [API documentation](https://www.scaleway.com/en/developers/api/webhosting/hosting-api/).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumi/scaleway";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const byName = scaleway.hosting.getOffer({
* name: "lite",
* controlPanel: "Cpanel",
* });
* const main = new scaleway.hosting.Hosting("main", {
* offerId: byName.then(byName => byName.offerId),
* email: "your@email.com",
* domain: "yourdomain.com",
* tags: [
* "webhosting",
* "provider",
* "terraform",
* ],
* });
* ```
*
* ## Import
*
* Hostings can be imported using the `{region}/{id}`, e.g.
*
* bash
*
* ```sh
* $ pulumi import scaleway:hosting/hosting:Hosting hosting01 fr-par/11111111-1111-1111-1111-111111111111
* ```
*/
export declare class Hosting extends pulumi.CustomResource {
/**
* Get an existing Hosting 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?: HostingState, opts?: pulumi.CustomResourceOptions): Hosting;
/**
* Returns true if the given object is an instance of Hosting. 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 Hosting;
/**
* The URL to connect to cPanel Dashboard and to Webmail interface.
*/
readonly cpanelUrls: pulumi.Output<outputs.hosting.HostingCpanelUrl[]>;
/**
* Date and time of hosting's creation (RFC 3339 format).
*/
readonly createdAt: pulumi.Output<string>;
/**
* The DNS status of the hosting.
*/
readonly dnsStatus: pulumi.Output<string>;
/**
* The domain name of the hosting.
*/
readonly domain: pulumi.Output<string>;
/**
* The contact email of the client for the hosting.
*/
readonly email: pulumi.Output<string>;
/**
* List of nameservers associated with the webhosting.
*/
readonly nameServers: pulumi.Output<outputs.hosting.HostingNameServer[]>;
/**
* The ID of the selected offer for the hosting.
*/
readonly offerId: pulumi.Output<string>;
/**
* The name of the active offer.
*/
readonly offerName: pulumi.Output<string>;
/**
* The IDs of the selected options for the hosting.
*/
readonly optionIds: pulumi.Output<string[] | undefined>;
/**
* The active options of the hosting.
*/
readonly options: pulumi.Output<outputs.hosting.HostingOption[]>;
/**
* (Deprecated) The organization ID the hosting is associated with.
*
* @deprecated The organizationId field is deprecated and will be removed in the next major version.
*/
readonly organizationId: pulumi.Output<string>;
/**
* The hostname of the host platform.
*/
readonly platformHostname: pulumi.Output<string>;
/**
* The number of the host platform.
*/
readonly platformNumber: pulumi.Output<number>;
/**
* `projectId`) The ID of the project the VPC is associated with.
*/
readonly projectId: pulumi.Output<string>;
/**
* List of DNS records associated with the webhosting.
*/
readonly records: pulumi.Output<outputs.hosting.HostingRecord[]>;
/**
* `region`) The region of the Hosting.
*/
readonly region: pulumi.Output<string>;
/**
* The hosting status.
*/
readonly status: pulumi.Output<string>;
/**
* The tags associated with the hosting.
*/
readonly tags: pulumi.Output<string[]>;
/**
* Date and time of hosting's last update (RFC 3339 format).
*/
readonly updatedAt: pulumi.Output<string>;
/**
* The main hosting cPanel username.
*/
readonly username: pulumi.Output<string>;
/**
* Create a Hosting 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: HostingArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Hosting resources.
*/
export interface HostingState {
/**
* The URL to connect to cPanel Dashboard and to Webmail interface.
*/
cpanelUrls?: pulumi.Input<pulumi.Input<inputs.hosting.HostingCpanelUrl>[]>;
/**
* Date and time of hosting's creation (RFC 3339 format).
*/
createdAt?: pulumi.Input<string>;
/**
* The DNS status of the hosting.
*/
dnsStatus?: pulumi.Input<string>;
/**
* The domain name of the hosting.
*/
domain?: pulumi.Input<string>;
/**
* The contact email of the client for the hosting.
*/
email?: pulumi.Input<string>;
/**
* List of nameservers associated with the webhosting.
*/
nameServers?: pulumi.Input<pulumi.Input<inputs.hosting.HostingNameServer>[]>;
/**
* The ID of the selected offer for the hosting.
*/
offerId?: pulumi.Input<string>;
/**
* The name of the active offer.
*/
offerName?: pulumi.Input<string>;
/**
* The IDs of the selected options for the hosting.
*/
optionIds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The active options of the hosting.
*/
options?: pulumi.Input<pulumi.Input<inputs.hosting.HostingOption>[]>;
/**
* (Deprecated) The organization ID the hosting is associated with.
*
* @deprecated The organizationId field is deprecated and will be removed in the next major version.
*/
organizationId?: pulumi.Input<string>;
/**
* The hostname of the host platform.
*/
platformHostname?: pulumi.Input<string>;
/**
* The number of the host platform.
*/
platformNumber?: pulumi.Input<number>;
/**
* `projectId`) The ID of the project the VPC is associated with.
*/
projectId?: pulumi.Input<string>;
/**
* List of DNS records associated with the webhosting.
*/
records?: pulumi.Input<pulumi.Input<inputs.hosting.HostingRecord>[]>;
/**
* `region`) The region of the Hosting.
*/
region?: pulumi.Input<string>;
/**
* The hosting status.
*/
status?: pulumi.Input<string>;
/**
* The tags associated with the hosting.
*/
tags?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Date and time of hosting's last update (RFC 3339 format).
*/
updatedAt?: pulumi.Input<string>;
/**
* The main hosting cPanel username.
*/
username?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Hosting resource.
*/
export interface HostingArgs {
/**
* The domain name of the hosting.
*/
domain: pulumi.Input<string>;
/**
* The contact email of the client for the hosting.
*/
email: pulumi.Input<string>;
/**
* The ID of the selected offer for the hosting.
*/
offerId: pulumi.Input<string>;
/**
* The IDs of the selected options for the hosting.
*/
optionIds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* `projectId`) The ID of the project the VPC is associated with.
*/
projectId?: pulumi.Input<string>;
/**
* `region`) The region of the Hosting.
*/
region?: pulumi.Input<string>;
/**
* The tags associated with the hosting.
*/
tags?: pulumi.Input<pulumi.Input<string>[]>;
}