@lbrlabs/pulumi-scaleway
Version:
A Pulumi package for creating and managing scaleway cloud resources.
245 lines (244 loc) • 7.37 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 documentation](https://www.scaleway.com/en/developers/api/webhosting/).
*
* ## Example
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@lbrlabs/pulumi-scaleway";
* import * as scaleway from "@pulumi/scaleway";
*
* const byName = scaleway.getWebHostOffer({
* name: "lite",
* });
* const main = new scaleway.Webhosting("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:index/webhosting:Webhosting hosting01 fr-par/11111111-1111-1111-1111-111111111111
* ```
*/
export declare class Webhosting extends pulumi.CustomResource {
/**
* Get an existing Webhosting 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?: WebhostingState, opts?: pulumi.CustomResourceOptions): Webhosting;
/**
* Returns true if the given object is an instance of Webhosting. 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 Webhosting;
/**
* The URL to connect to cPanel Dashboard and to Webmail interface.
*/
readonly cpanelUrls: pulumi.Output<outputs.WebhostingCpanelUrl[]>;
/**
* 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>;
/**
* 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.WebhostingOption[]>;
/**
* The organization ID the hosting is associated with.
*/
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>;
/**
* `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 Webhosting 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: WebhostingArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Webhosting resources.
*/
export interface WebhostingState {
/**
* The URL to connect to cPanel Dashboard and to Webmail interface.
*/
cpanelUrls?: pulumi.Input<pulumi.Input<inputs.WebhostingCpanelUrl>[]>;
/**
* 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>;
/**
* 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.WebhostingOption>[]>;
/**
* The organization ID the hosting is associated with.
*/
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>;
/**
* `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 Webhosting resource.
*/
export interface WebhostingArgs {
/**
* 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>[]>;
}