@upcloud/pulumi-upcloud/server.d.ts

A Pulumi package for creating and managing UpCloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
 * The UpCloud server resource allows the creation, update and deletion of a [cloud server](https://upcloud.com/products/cloud-servers).
 *
 * ## Import
 *
 * ```sh
 * $ pulumi import upcloud:index/server:Server example_server ead4544f-10bf-42a3-b98a-a0fea2e2ad14
 * ```
 */
export declare class Server extends pulumi.CustomResource {
    /**
     * Get an existing Server 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?: ServerState, opts?: pulumi.CustomResourceOptions): Server;
    /**
     * Returns true if the given object is an instance of Server.  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 Server;
    /**
     * The boot device order, `cdrom`|`disk`|`network` or comma separated combination of those values. Defaults to `disk`
     */
    readonly bootOrder: pulumi.Output<string>;
    /**
     * The number of CPU cores for the server
     */
    readonly cpu: pulumi.Output<number>;
    /**
     * Are firewall rules active for the server
     */
    readonly firewall: pulumi.Output<boolean>;
    /**
     * Use this to start the VM on a specific host. Refers to value from host -attribute. Only available for private cloud
     * hosts
     */
    readonly host: pulumi.Output<number>;
    /**
     * The hostname of the server.
     */
    readonly hostname: pulumi.Output<string>;
    /**
     * User defined key-value pairs to classify the server.
     */
    readonly labels: pulumi.Output<{
        [key: string]: string;
    }>;
    /**
     * Configure access credentials to the server
     */
    readonly login: pulumi.Output<outputs.ServerLogin | undefined>;
    /**
     * The amount of memory for the server (in megabytes)
     */
    readonly mem: pulumi.Output<number>;
    /**
     * Is metadata service active for the server
     */
    readonly metadata: pulumi.Output<boolean | undefined>;
    /**
     * One or more blocks describing the network interfaces of the server. In addition to list order, the configured network
     * interfaces are matched to the server's actual network interfaces by `index` and `ipAddress` fields. This is to avoid
     * public and utility network interfaces being re-assigned when the server is updated. This might result to inaccurate
     * diffs in the plan, when interfaces are re-ordered or when interface is removed from the middle of the list. We recommend
     * explicitly setting the value for `index` in configuration, when re-ordering interfaces or when removing interface from
     * middle of the list.
     */
    readonly networkInterfaces: pulumi.Output<outputs.ServerNetworkInterface[] | undefined>;
    /**
     * The model of the server's network interfaces
     */
    readonly nicModel: pulumi.Output<string>;
    /**
     * The pricing plan used for the server. You can list available server plans with `upctl server plans`
     */
    readonly plan: pulumi.Output<string>;
    /**
     * The UUID of a server group to attach this server to. Note that the server can also be attached to a server group via the
     * `members` property of `upcloud.ServerGroup`. Only one of the these should be defined at a time. This value is only
     * updated if it has been set to non-zero value.
     */
    readonly serverGroup: pulumi.Output<string | undefined>;
    readonly simpleBackup: pulumi.Output<outputs.ServerSimpleBackup | undefined>;
    /**
     * A set of storage devices associated with the server
     */
    readonly storageDevices: pulumi.Output<outputs.ServerStorageDevice[] | undefined>;
    /**
     * The server related tags
     */
    readonly tags: pulumi.Output<string[]>;
    /**
     * Block describing the preconfigured operating system
     */
    readonly template: pulumi.Output<outputs.ServerTemplate | undefined>;
    /**
     * The timezone of the server. The timezone must be a valid timezone string, e.g. `Europe/Helsinki`.
     */
    readonly timezone: pulumi.Output<string>;
    /**
     * A short, informational description of the server.
     */
    readonly title: pulumi.Output<string>;
    /**
     * Defines URL for a server setup script, or the script body itself
     */
    readonly userData: pulumi.Output<string | undefined>;
    /**
     * The model of the server's video interface
     */
    readonly videoModel: pulumi.Output<string>;
    /**
     * The zone in which the server will be hosted, e.g. `de-fra1`. You can list available zones with `upctl zone list`.
     */
    readonly zone: pulumi.Output<string>;
    /**
     * Create a Server 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: ServerArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Server resources.
 */
export interface ServerState {
    /**
     * The boot device order, `cdrom`|`disk`|`network` or comma separated combination of those values. Defaults to `disk`
     */
    bootOrder?: pulumi.Input<string>;
    /**
     * The number of CPU cores for the server
     */
    cpu?: pulumi.Input<number>;
    /**
     * Are firewall rules active for the server
     */
    firewall?: pulumi.Input<boolean>;
    /**
     * Use this to start the VM on a specific host. Refers to value from host -attribute. Only available for private cloud
     * hosts
     */
    host?: pulumi.Input<number>;
    /**
     * The hostname of the server.
     */
    hostname?: pulumi.Input<string>;
    /**
     * User defined key-value pairs to classify the server.
     */
    labels?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * Configure access credentials to the server
     */
    login?: pulumi.Input<inputs.ServerLogin>;
    /**
     * The amount of memory for the server (in megabytes)
     */
    mem?: pulumi.Input<number>;
    /**
     * Is metadata service active for the server
     */
    metadata?: pulumi.Input<boolean>;
    /**
     * One or more blocks describing the network interfaces of the server. In addition to list order, the configured network
     * interfaces are matched to the server's actual network interfaces by `index` and `ipAddress` fields. This is to avoid
     * public and utility network interfaces being re-assigned when the server is updated. This might result to inaccurate
     * diffs in the plan, when interfaces are re-ordered or when interface is removed from the middle of the list. We recommend
     * explicitly setting the value for `index` in configuration, when re-ordering interfaces or when removing interface from
     * middle of the list.
     */
    networkInterfaces?: pulumi.Input<pulumi.Input<inputs.ServerNetworkInterface>[]>;
    /**
     * The model of the server's network interfaces
     */
    nicModel?: pulumi.Input<string>;
    /**
     * The pricing plan used for the server. You can list available server plans with `upctl server plans`
     */
    plan?: pulumi.Input<string>;
    /**
     * The UUID of a server group to attach this server to. Note that the server can also be attached to a server group via the
     * `members` property of `upcloud.ServerGroup`. Only one of the these should be defined at a time. This value is only
     * updated if it has been set to non-zero value.
     */
    serverGroup?: pulumi.Input<string>;
    simpleBackup?: pulumi.Input<inputs.ServerSimpleBackup>;
    /**
     * A set of storage devices associated with the server
     */
    storageDevices?: pulumi.Input<pulumi.Input<inputs.ServerStorageDevice>[]>;
    /**
     * The server related tags
     */
    tags?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * Block describing the preconfigured operating system
     */
    template?: pulumi.Input<inputs.ServerTemplate>;
    /**
     * The timezone of the server. The timezone must be a valid timezone string, e.g. `Europe/Helsinki`.
     */
    timezone?: pulumi.Input<string>;
    /**
     * A short, informational description of the server.
     */
    title?: pulumi.Input<string>;
    /**
     * Defines URL for a server setup script, or the script body itself
     */
    userData?: pulumi.Input<string>;
    /**
     * The model of the server's video interface
     */
    videoModel?: pulumi.Input<string>;
    /**
     * The zone in which the server will be hosted, e.g. `de-fra1`. You can list available zones with `upctl zone list`.
     */
    zone?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a Server resource.
 */
export interface ServerArgs {
    /**
     * The boot device order, `cdrom`|`disk`|`network` or comma separated combination of those values. Defaults to `disk`
     */
    bootOrder?: pulumi.Input<string>;
    /**
     * The number of CPU cores for the server
     */
    cpu?: pulumi.Input<number>;
    /**
     * Are firewall rules active for the server
     */
    firewall?: pulumi.Input<boolean>;
    /**
     * Use this to start the VM on a specific host. Refers to value from host -attribute. Only available for private cloud
     * hosts
     */
    host?: pulumi.Input<number>;
    /**
     * The hostname of the server.
     */
    hostname: pulumi.Input<string>;
    /**
     * User defined key-value pairs to classify the server.
     */
    labels?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * Configure access credentials to the server
     */
    login?: pulumi.Input<inputs.ServerLogin>;
    /**
     * The amount of memory for the server (in megabytes)
     */
    mem?: pulumi.Input<number>;
    /**
     * Is metadata service active for the server
     */
    metadata?: pulumi.Input<boolean>;
    /**
     * One or more blocks describing the network interfaces of the server. In addition to list order, the configured network
     * interfaces are matched to the server's actual network interfaces by `index` and `ipAddress` fields. This is to avoid
     * public and utility network interfaces being re-assigned when the server is updated. This might result to inaccurate
     * diffs in the plan, when interfaces are re-ordered or when interface is removed from the middle of the list. We recommend
     * explicitly setting the value for `index` in configuration, when re-ordering interfaces or when removing interface from
     * middle of the list.
     */
    networkInterfaces?: pulumi.Input<pulumi.Input<inputs.ServerNetworkInterface>[]>;
    /**
     * The model of the server's network interfaces
     */
    nicModel?: pulumi.Input<string>;
    /**
     * The pricing plan used for the server. You can list available server plans with `upctl server plans`
     */
    plan?: pulumi.Input<string>;
    /**
     * The UUID of a server group to attach this server to. Note that the server can also be attached to a server group via the
     * `members` property of `upcloud.ServerGroup`. Only one of the these should be defined at a time. This value is only
     * updated if it has been set to non-zero value.
     */
    serverGroup?: pulumi.Input<string>;
    simpleBackup?: pulumi.Input<inputs.ServerSimpleBackup>;
    /**
     * A set of storage devices associated with the server
     */
    storageDevices?: pulumi.Input<pulumi.Input<inputs.ServerStorageDevice>[]>;
    /**
     * The server related tags
     */
    tags?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * Block describing the preconfigured operating system
     */
    template?: pulumi.Input<inputs.ServerTemplate>;
    /**
     * The timezone of the server. The timezone must be a valid timezone string, e.g. `Europe/Helsinki`.
     */
    timezone?: pulumi.Input<string>;
    /**
     * A short, informational description of the server.
     */
    title?: pulumi.Input<string>;
    /**
     * Defines URL for a server setup script, or the script body itself
     */
    userData?: pulumi.Input<string>;
    /**
     * The model of the server's video interface
     */
    videoModel?: pulumi.Input<string>;
    /**
     * The zone in which the server will be hosted, e.g. `de-fra1`. You can list available zones with `upctl zone list`.
     */
    zone: pulumi.Input<string>;
}