@pulumiverse/scaleway

import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as scaleway from "@pulumiverse/scaleway"; * import * as std from "@pulumi/std"; * * //## With cloud-init * const mySshKey = scaleway.iam.getSshKey({ * name: "main", * }); * const myOs = scaleway.elasticmetal.getOs({ * zone: "fr-par-1", * name: "Ubuntu", * version: "22.04 LTS (Jammy Jellyfish)", * }); * const myOffer = scaleway.elasticmetal.getOffer({ * zone: "fr-par-2", * name: "EM-I220E-NVME", * }); * const myServerCi = new scaleway.elasticmetal.Server("my_server_ci", { * zone: "fr-par-2", * offer: myOffer.then(myOffer => myOffer.offerId), * os: myOs.then(myOs => myOs.osId), * sshKeyIds: [mySshKey.then(mySshKey => mySshKey.id)], * cloudInit: std.file({ * input: "userdata.yaml", * }).result, * }); * ``` * * ## Import * * Baremetal servers can be imported using the `{zone}/{id}`, e.g. * * ```sh * $ pulumi import scaleway:elasticmetal/server:Server web fr-par-2/11111111-1111-1111-1111-111111111111 * ``` */ 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; /** * Configuration data to pass to cloud-init such as a YAML cloud config or a user-data script. Accepts either a string containing the content or a path to a file (for example `file("cloud-init.yml")`). Max length: 127998 characters. Updates to `cloudInit` will update the server user-data via the API and do not trigger a reinstall; however, a reboot of the server is required for the OS to re-run cloud-init and apply the changes. Only supported for Offers that have cloud-init enabled. You can check available offers with `scw baremetal list offers` command. */ readonly cloudInit: pulumi.Output<string>; /** * A description for the server. */ readonly description: pulumi.Output<string | undefined>; /** * The domain of the server. */ readonly domain: pulumi.Output<string>; /** * The hostname of the server. */ readonly hostname: pulumi.Output<string | undefined>; /** * If True, this boolean allows to create a server without the install config if you want to provide it later. */ readonly installConfigAfterward: pulumi.Output<boolean | undefined>; /** * (List of) The IPs of the server. */ readonly ips: pulumi.Output<outputs.elasticmetal.ServerIp[]>; /** * (List of) The IPv4 addresses of the server. */ readonly ipv4s: pulumi.Output<outputs.elasticmetal.ServerIpv4[]>; /** * (List of) The IPv6 addresses of the server. */ readonly ipv6s: pulumi.Output<outputs.elasticmetal.ServerIpv6[]>; /** * The name of the server. */ readonly name: pulumi.Output<string>; /** * The offer UUID of the baremetal server. * Use [this endpoint](https://www.scaleway.com/en/developers/api/elastic-metal/#path-servers-get-a-specific-elastic-metal-server) to find the right offer. * * > **Important:** Updates to `offer` will recreate the server. * > **Important** If you migrate to a monthly subscription, you cannot downgrade back to an hourly plan. Ensure that the monthly plan meets your needs before making the switch. */ readonly offer: pulumi.Output<string>; /** * The ID of the offer. */ readonly offerId: pulumi.Output<string>; /** * The name of the offer. */ readonly offerName: pulumi.Output<string>; /** * The options to enable on the server. * > The `options` block supports: */ readonly options: pulumi.Output<outputs.elasticmetal.ServerOption[] | undefined>; /** * The organization ID the server is associated with. */ readonly organizationId: pulumi.Output<string>; /** * The UUID of the os to install on the server. * Use [this endpoint](https://www.scaleway.com/en/developers/api/elastic-metal/#path-os-list-available-oses) to find the right OS ID. * > **Important:** Updates to `os` will reinstall the server. */ readonly os: pulumi.Output<string | undefined>; /** * The name of the os. */ readonly osName: pulumi.Output<string>; /** * The partitioning schema in JSON format */ readonly partitioning: pulumi.Output<string | undefined>; /** * Password used for the installation. May be required depending on used os. Only one of `password` or `passwordWo` should be specified. */ readonly password: pulumi.Output<string | undefined>; /** * **NOTE:** This field is write-only and its value will not be updated in state as part of read operations. * Password used for the installation in write-only mode. Only one of `password` or `passwordWo` should be specified. `passwordWo` will not be set in the Terraform state. To update the `passwordWo`, you must also update the `passwordWoVersion`. May be required depending on used os. */ readonly passwordWo: pulumi.Output<string | undefined>; /** * The version of the write-only password. To update the `passwordWo`, you must also update the `passwordWoVersion`. */ readonly passwordWoVersion: pulumi.Output<number | undefined>; /** * The list of private IPv4 and IPv6 addresses associated with the resource. */ readonly privateIps: pulumi.Output<outputs.elasticmetal.ServerPrivateIp[]>; /** * The private networks to attach to the server. For more information, see [the documentation](https://www.scaleway.com/en/docs/compute/elastic-metal/how-to/use-private-networks/) */ readonly privateNetworks: pulumi.Output<outputs.elasticmetal.ServerPrivateNetwork[] | undefined>; /** * `projectId`) The ID of the project the server is associated with. */ readonly projectId: pulumi.Output<string>; /** * Set to true to activate server protection option. */ readonly protected: pulumi.Output<boolean | undefined>; /** * If True, this boolean allows to reinstall the server on install config changes. * > **Important:** Updates to `sshKeyIds`, `user`, `password`, `serviceUser` or `servicePassword` will not take effect on the server, it requires to reinstall it. To do so please set 'reinstall_on_config_changes' argument to true. */ readonly reinstallOnConfigChanges: pulumi.Output<boolean | undefined>; /** * Password used for the service to install. May be required depending on used os. Only one of `servicePassword` or `servicePasswordWo` should be specified. */ readonly servicePassword: pulumi.Output<string | undefined>; /** * **NOTE:** This field is write-only and its value will not be updated in state as part of read operations. * Password used for the service to install in write-only mode. Only one of `servicePassword` or `servicePasswordWo` should be specified. `servicePasswordWo` will not be set in the Terraform state. To update the `servicePasswordWo`, you must also update the `servicePasswordWoVersion`. May be required depending on used os. */ readonly servicePasswordWo: pulumi.Output<string | undefined>; /** * The version of the write-only service password. To update the `servicePasswordWo`, you must also update the `servicePasswordWoVersion`. */ readonly servicePasswordWoVersion: pulumi.Output<number | undefined>; /** * User used for the service to install. */ readonly serviceUser: pulumi.Output<string>; /** * List of SSH keys allowed to connect to the server. */ readonly sshKeyIds: pulumi.Output<string[] | undefined>; /** * The tags associated with the server. */ readonly tags: pulumi.Output<string[]>; /** * User used for the installation. */ readonly user: pulumi.Output<string>; /** * `zone`) The zone in which the server should be created. */ readonly zone: pulumi.Output<string | undefined>; /** * 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 { /** * Configuration data to pass to cloud-init such as a YAML cloud config or a user-data script. Accepts either a string containing the content or a path to a file (for example `file("cloud-init.yml")`). Max length: 127998 characters. Updates to `cloudInit` will update the server user-data via the API and do not trigger a reinstall; however, a reboot of the server is required for the OS to re-run cloud-init and apply the changes. Only supported for Offers that have cloud-init enabled. You can check available offers with `scw baremetal list offers` command. */ cloudInit?: pulumi.Input<string | undefined>; /** * A description for the server. */ description?: pulumi.Input<string | undefined>; /** * The domain of the server. */ domain?: pulumi.Input<string | undefined>; /** * The hostname of the server. */ hostname?: pulumi.Input<string | undefined>; /** * If True, this boolean allows to create a server without the install config if you want to provide it later. */ installConfigAfterward?: pulumi.Input<boolean | undefined>; /** * (List of) The IPs of the server. */ ips?: pulumi.Input<pulumi.Input<inputs.elasticmetal.ServerIp>[] | undefined>; /** * (List of) The IPv4 addresses of the server. */ ipv4s?: pulumi.Input<pulumi.Input<inputs.elasticmetal.ServerIpv4>[] | undefined>; /** * (List of) The IPv6 addresses of the server. */ ipv6s?: pulumi.Input<pulumi.Input<inputs.elasticmetal.ServerIpv6>[] | undefined>; /** * The name of the server. */ name?: pulumi.Input<string | undefined>; /** * The offer UUID of the baremetal server. * Use [this endpoint](https://www.scaleway.com/en/developers/api/elastic-metal/#path-servers-get-a-specific-elastic-metal-server) to find the right offer. * * > **Important:** Updates to `offer` will recreate the server. * > **Important** If you migrate to a monthly subscription, you cannot downgrade back to an hourly plan. Ensure that the monthly plan meets your needs before making the switch. */ offer?: pulumi.Input<string | undefined>; /** * The ID of the offer. */ offerId?: pulumi.Input<string | undefined>; /** * The name of the offer. */ offerName?: pulumi.Input<string | undefined>; /** * The options to enable on the server. * > The `options` block supports: */ options?: pulumi.Input<pulumi.Input<inputs.elasticmetal.ServerOption>[] | undefined>; /** * The organization ID the server is associated with. */ organizationId?: pulumi.Input<string | undefined>; /** * The UUID of the os to install on the server. * Use [this endpoint](https://www.scaleway.com/en/developers/api/elastic-metal/#path-os-list-available-oses) to find the right OS ID. * > **Important:** Updates to `os` will reinstall the server. */ os?: pulumi.Input<string | undefined>; /** * The name of the os. */ osName?: pulumi.Input<string | undefined>; /** * The partitioning schema in JSON format */ partitioning?: pulumi.Input<string | undefined>; /** * Password used for the installation. May be required depending on used os. Only one of `password` or `passwordWo` should be specified. */ password?: pulumi.Input<string | undefined>; /** * **NOTE:** This field is write-only and its value will not be updated in state as part of read operations. * Password used for the installation in write-only mode. Only one of `password` or `passwordWo` should be specified. `passwordWo` will not be set in the Terraform state. To update the `passwordWo`, you must also update the `passwordWoVersion`. May be required depending on used os. */ passwordWo?: pulumi.Input<string | undefined>; /** * The version of the write-only password. To update the `passwordWo`, you must also update the `passwordWoVersion`. */ passwordWoVersion?: pulumi.Input<number | undefined>; /** * The list of private IPv4 and IPv6 addresses associated with the resource. */ privateIps?: pulumi.Input<pulumi.Input<inputs.elasticmetal.ServerPrivateIp>[] | undefined>; /** * The private networks to attach to the server. For more information, see [the documentation](https://www.scaleway.com/en/docs/compute/elastic-metal/how-to/use-private-networks/) */ privateNetworks?: pulumi.Input<pulumi.Input<inputs.elasticmetal.ServerPrivateNetwork>[] | undefined>; /** * `projectId`) The ID of the project the server is associated with. */ projectId?: pulumi.Input<string | undefined>; /** * Set to true to activate server protection option. */ protected?: pulumi.Input<boolean | undefined>; /** * If True, this boolean allows to reinstall the server on install config changes. * > **Important:** Updates to `sshKeyIds`, `user`, `password`, `serviceUser` or `servicePassword` will not take effect on the server, it requires to reinstall it. To do so please set 'reinstall_on_config_changes' argument to true. */ reinstallOnConfigChanges?: pulumi.Input<boolean | undefined>; /** * Password used for the service to install. May be required depending on used os. Only one of `servicePassword` or `servicePasswordWo` should be specified. */ servicePassword?: pulumi.Input<string | undefined>; /** * **NOTE:** This field is write-only and its value will not be updated in state as part of read operations. * Password used for the service to install in write-only mode. Only one of `servicePassword` or `servicePasswordWo` should be specified. `servicePasswordWo` will not be set in the Terraform state. To update the `servicePasswordWo`, you must also update the `servicePasswordWoVersion`. May be required depending on used os. */ servicePasswordWo?: pulumi.Input<string | undefined>; /** * The version of the write-only service password. To update the `servicePasswordWo`, you must also update the `servicePasswordWoVersion`. */ servicePasswordWoVersion?: pulumi.Input<number | undefined>; /** * User used for the service to install. */ serviceUser?: pulumi.Input<string | undefined>; /** * List of SSH keys allowed to connect to the server. */ sshKeyIds?: pulumi.Input<pulumi.Input<string>[] | undefined>; /** * The tags associated with the server. */ tags?: pulumi.Input<pulumi.Input<string>[] | undefined>; /** * User used for the installation. */ user?: pulumi.Input<string | undefined>; /** * `zone`) The zone in which the server should be created. */ zone?: pulumi.Input<string | undefined>; } /** * The set of arguments for constructing a Server resource. */ export interface ServerArgs { /** * Configuration data to pass to cloud-init such as a YAML cloud config or a user-data script. Accepts either a string containing the content or a path to a file (for example `file("cloud-init.yml")`). Max length: 127998 characters. Updates to `cloudInit` will update the server user-data via the API and do not trigger a reinstall; however, a reboot of the server is required for the OS to re-run cloud-init and apply the changes. Only supported for Offers that have cloud-init enabled. You can check available offers with `scw baremetal list offers` command. */ cloudInit?: pulumi.Input<string | undefined>; /** * A description for the server. */ description?: pulumi.Input<string | undefined>; /** * The hostname of the server. */ hostname?: pulumi.Input<string | undefined>; /** * If True, this boolean allows to create a server without the install config if you want to provide it later. */ installConfigAfterward?: pulumi.Input<boolean | undefined>; /** * The name of the server. */ name?: pulumi.Input<string | undefined>; /** * The offer UUID of the baremetal server. * Use [this endpoint](https://www.scaleway.com/en/developers/api/elastic-metal/#path-servers-get-a-specific-elastic-metal-server) to find the right offer. * * > **Important:** Updates to `offer` will recreate the server. * > **Important** If you migrate to a monthly subscription, you cannot downgrade back to an hourly plan. Ensure that the monthly plan meets your needs before making the switch. */ offer: pulumi.Input<string>; /** * The options to enable on the server. * > The `options` block supports: */ options?: pulumi.Input<pulumi.Input<inputs.elasticmetal.ServerOption>[] | undefined>; /** * The UUID of the os to install on the server. * Use [this endpoint](https://www.scaleway.com/en/developers/api/elastic-metal/#path-os-list-available-oses) to find the right OS ID. * > **Important:** Updates to `os` will reinstall the server. */ os?: pulumi.Input<string | undefined>; /** * The partitioning schema in JSON format */ partitioning?: pulumi.Input<string | undefined>; /** * Password used for the installation. May be required depending on used os. Only one of `password` or `passwordWo` should be specified. */ password?: pulumi.Input<string | undefined>; /** * **NOTE:** This field is write-only and its value will not be updated in state as part of read operations. * Password used for the installation in write-only mode. Only one of `password` or `passwordWo` should be specified. `passwordWo` will not be set in the Terraform state. To update the `passwordWo`, you must also update the `passwordWoVersion`. May be required depending on used os. */ passwordWo?: pulumi.Input<string | undefined>; /** * The version of the write-only password. To update the `passwordWo`, you must also update the `passwordWoVersion`. */ passwordWoVersion?: pulumi.Input<number | undefined>; /** * The list of private IPv4 and IPv6 addresses associated with the resource. */ privateIps?: pulumi.Input<pulumi.Input<inputs.elasticmetal.ServerPrivateIp>[] | undefined>; /** * The private networks to attach to the server. For more information, see [the documentation](https://www.scaleway.com/en/docs/compute/elastic-metal/how-to/use-private-networks/) */ privateNetworks?: pulumi.Input<pulumi.Input<inputs.elasticmetal.ServerPrivateNetwork>[] | undefined>; /** * `projectId`) The ID of the project the server is associated with. */ projectId?: pulumi.Input<string | undefined>; /** * Set to true to activate server protection option. */ protected?: pulumi.Input<boolean | undefined>; /** * If True, this boolean allows to reinstall the server on install config changes. * > **Important:** Updates to `sshKeyIds`, `user`, `password`, `serviceUser` or `servicePassword` will not take effect on the server, it requires to reinstall it. To do so please set 'reinstall_on_config_changes' argument to true. */ reinstallOnConfigChanges?: pulumi.Input<boolean | undefined>; /** * Password used for the service to install. May be required depending on used os. Only one of `servicePassword` or `servicePasswordWo` should be specified. */ servicePassword?: pulumi.Input<string | undefined>; /** * **NOTE:** This field is write-only and its value will not be updated in state as part of read operations. * Password used for the service to install in write-only mode. Only one of `servicePassword` or `servicePasswordWo` should be specified. `servicePasswordWo` will not be set in the Terraform state. To update the `servicePasswordWo`, you must also update the `servicePasswordWoVersion`. May be required depending on used os. */ servicePasswordWo?: pulumi.Input<string | undefined>; /** * The version of the write-only service password. To update the `servicePasswordWo`, you must also update the `servicePasswordWoVersion`. */ servicePasswordWoVersion?: pulumi.Input<number | undefined>; /** * User used for the service to install. */ serviceUser?: pulumi.Input<string | undefined>; /** * List of SSH keys allowed to connect to the server. */ sshKeyIds?: pulumi.Input<pulumi.Input<string>[] | undefined>; /** * The tags associated with the server. */ tags?: pulumi.Input<pulumi.Input<string>[] | undefined>; /** * User used for the installation. */ user?: pulumi.Input<string | undefined>; /** * `zone`) The zone in which the server should be created. */ zone?: pulumi.Input<string | undefined>; } //# sourceMappingURL=server.d.ts.map