@pulumiverse/scaleway/instance/getServer.d.ts

A Pulumi package for creating and managing Scaleway cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * Gets information about an instance server.
 */
export declare function getServer(args?: GetServerArgs, opts?: pulumi.InvokeOptions): Promise<GetServerResult>;
/**
 * A collection of arguments for invoking getServer.
 */
export interface GetServerArgs {
    /**
     * The server name. Only one of `name` and `serverId` should be specified.
     */
    name?: string;
    /**
     * The ID of the project the instance server is associated with.
     */
    projectId?: string;
    /**
     * The server id. Only one of `name` and `serverId` should be specified.
     */
    serverId?: string;
    /**
     * `zone`) The zone in which the server exists.
     */
    zone?: string;
}
/**
 * A collection of values returned by getServer.
 */
export interface GetServerResult {
    /**
     * The [additional volumes](https://developers.scaleway.com/en/products/instance/api/#volumes-7e8a39)
     * attached to the server.
     */
    readonly additionalVolumeIds: string[];
    readonly bootType: string;
    readonly bootscriptId: string;
    /**
     * The cloud init script associated with this server.
     */
    readonly cloudInit: string;
    /**
     * True if dynamic IP in enable on the server.
     */
    readonly enableDynamicIp: boolean;
    /**
     * Determines if IPv6 is enabled for the server.
     */
    readonly enableIpv6: boolean;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    /**
     * The UUID and the label of the base image used by the server.
     */
    readonly image: string;
    readonly ipId: string;
    readonly ipIds: string[];
    /**
     * The default ipv6 address routed to the server. ( Only set when enableIpv6 is set to true )
     */
    readonly ipv6Address: string;
    /**
     * The ipv6 gateway address. ( Only set when enableIpv6 is set to true )
     */
    readonly ipv6Gateway: string;
    /**
     * The prefix length of the ipv6 subnet routed to the server. ( Only set when enableIpv6 is set to true )
     */
    readonly ipv6PrefixLength: number;
    readonly name?: string;
    /**
     * The ID of the organization the server is associated with.
     */
    readonly organizationId: string;
    /**
     * The [placement group](https://developers.scaleway.com/en/products/instance/api/#placement-groups-d8f653) the server is attached to.
     */
    readonly placementGroupId: string;
    /**
     * True when the placement group policy is respected.
     */
    readonly placementGroupPolicyRespected: boolean;
    /**
     * The Scaleway internal IP address of the server.
     */
    readonly privateIp: string;
    readonly privateIps: outputs.instance.GetServerPrivateIp[];
    readonly privateNetworks: outputs.instance.GetServerPrivateNetwork[];
    readonly projectId?: string;
    readonly protected: boolean;
    /**
     * The public IP address of the server.
     */
    readonly publicIp: string;
    /**
     * The list of public IPs of the server
     */
    readonly publicIps: outputs.instance.GetServerPublicIp[];
    readonly replaceOnTypeChange: boolean;
    readonly rootVolumes: outputs.instance.GetServerRootVolume[];
    /**
     * The [security group](https://developers.scaleway.com/en/products/instance/api/#security-groups-8d7f89) the server is attached to.
     */
    readonly securityGroupId: string;
    readonly serverId?: string;
    /**
     * The state of the server. Possible values are: `started`, `stopped` or `standby`.
     */
    readonly state: string;
    /**
     * The tags associated with the server.
     */
    readonly tags: string[];
    /**
     * The commercial type of the server.
     * You find all the available types on the [pricing page](https://www.scaleway.com/en/pricing/).
     */
    readonly type: string;
    /**
     * The user data associated with the server.
     */
    readonly userData: {
        [key: string]: string;
    };
    readonly zone?: string;
}
/**
 * Gets information about an instance server.
 */
export declare function getServerOutput(args?: GetServerOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetServerResult>;
/**
 * A collection of arguments for invoking getServer.
 */
export interface GetServerOutputArgs {
    /**
     * The server name. Only one of `name` and `serverId` should be specified.
     */
    name?: pulumi.Input<string>;
    /**
     * The ID of the project the instance server is associated with.
     */
    projectId?: pulumi.Input<string>;
    /**
     * The server id. Only one of `name` and `serverId` should be specified.
     */
    serverId?: pulumi.Input<string>;
    /**
     * `zone`) The zone in which the server exists.
     */
    zone?: pulumi.Input<string>;
}