Scaleway

v1.3.0 published on Thursday, Nov 3, 2022 by lbrlabs

getInstanceServer

Gets information about an instance server.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Scaleway = Pulumi.Scaleway;

return await Deployment.RunAsync(() => 
{
    var myKey = Scaleway.GetInstanceServer.Invoke(new()
    {
        ServerId = "11111111-1111-1111-1111-111111111111",
    });

});

package main

import (
	"github.com/lbrlabs/pulumi-scaleway/sdk/go/scaleway"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err = scaleway.LookupInstanceServer(ctx, &GetInstanceServerArgs{
			ServerId: pulumi.StringRef("11111111-1111-1111-1111-111111111111"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scaleway.ScalewayFunctions;
import com.pulumi.scaleway.inputs.GetInstanceServerArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var myKey = ScalewayFunctions.getInstanceServer(GetInstanceServerArgs.builder()
            .serverId("11111111-1111-1111-1111-111111111111")
            .build());

    }
}

import pulumi
import pulumi_scaleway as scaleway

my_key = scaleway.get_instance_server(server_id="11111111-1111-1111-1111-111111111111")

import * as pulumi from "@pulumi/pulumi";
import * as scaleway from "@pulumi/scaleway";

// Get info by server id
const myKey = pulumi.output(scaleway.getInstanceServer({
    serverId: "11111111-1111-1111-1111-111111111111",
}));

variables:
  myKey:
    fn::invoke:
      Function: scaleway:getInstanceServer
      Arguments:
        serverId: 11111111-1111-1111-1111-111111111111

Using getInstanceServer

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getInstanceServer(args: GetInstanceServerArgs, opts?: InvokeOptions): Promise<GetInstanceServerResult>
function getInstanceServerOutput(args: GetInstanceServerOutputArgs, opts?: InvokeOptions): Output<GetInstanceServerResult>

def get_instance_server(name: Optional[str] = None,
                        server_id: Optional[str] = None,
                        zone: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetInstanceServerResult
def get_instance_server_output(name: Optional[pulumi.Input[str]] = None,
                        server_id: Optional[pulumi.Input[str]] = None,
                        zone: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetInstanceServerResult]

func LookupInstanceServer(ctx *Context, args *LookupInstanceServerArgs, opts ...InvokeOption) (*LookupInstanceServerResult, error)
func LookupInstanceServerOutput(ctx *Context, args *LookupInstanceServerOutputArgs, opts ...InvokeOption) LookupInstanceServerResultOutput

> Note: This function is named LookupInstanceServer in the Go SDK.

public static class GetInstanceServer 
{
    public static Task<GetInstanceServerResult> InvokeAsync(GetInstanceServerArgs args, InvokeOptions? opts = null)
    public static Output<GetInstanceServerResult> Invoke(GetInstanceServerInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetInstanceServerResult> getInstanceServer(GetInstanceServerArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: scaleway:index/getInstanceServer:getInstanceServer
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: The server name. Only one of name and server_id should be specified.
ServerId string: The server id. Only one of name and server_id should be specified.
Zone string: zone) The zone in which the server exists.

Name string: The server name. Only one of name and server_id should be specified.
ServerId string: The server id. Only one of name and server_id should be specified.
Zone string: zone) The zone in which the server exists.

name String: The server name. Only one of name and server_id should be specified.
serverId String: The server id. Only one of name and server_id should be specified.
zone String: zone) The zone in which the server exists.

name string: The server name. Only one of name and server_id should be specified.
serverId string: The server id. Only one of name and server_id should be specified.
zone string: zone) The zone in which the server exists.

name str: The server name. Only one of name and server_id should be specified.
server_id str: The server id. Only one of name and server_id should be specified.
zone str: zone) The zone in which the server exists.

name String: The server name. Only one of name and server_id should be specified.
serverId String: The server id. Only one of name and server_id should be specified.
zone String: zone) The zone in which the server exists.

getInstanceServer Result

The following output properties are available:

AdditionalVolumeIds List<string>: The additional volumes attached to the server.
BootType string
BootscriptId string
CloudInit string: The cloud init script associated with this server.
EnableDynamicIp bool: True is dynamic IP in enable on the server.
EnableIpv6 bool: Determines if IPv6 is enabled for the server.
Id string: The provider-assigned unique ID for this managed resource.
Image string: The UUID and the label of the base image used by the server.
IpId string
Ipv6Address string: The default ipv6 address routed to the server. ( Only set when enable_ipv6 is set to true )
Ipv6Gateway string: The ipv6 gateway address. ( Only set when enable_ipv6 is set to true )
Ipv6PrefixLength int: The prefix length of the ipv6 subnet routed to the server. ( Only set when enable_ipv6 is set to true )
OrganizationId string: The ID of the organization the server is associated with.
PlacementGroupId string: The placement group the server is attached to.
PlacementGroupPolicyRespected bool: True when the placement group policy is respected.
PrivateIp string: The Scaleway internal IP address of the server.
PrivateNetworks List<Lbrlabs.PulumiPackage.Scaleway.Outputs.GetInstanceServerPrivateNetwork>
ProjectId string: The ID of the project the server is associated with.
PublicIp string: The public IPv4 address of the server.
RootVolumes List<Lbrlabs.PulumiPackage.Scaleway.Outputs.GetInstanceServerRootVolume>: Root volume attached to the server on creation.
SecurityGroupId string: The security group the server is attached to.
State string: The state of the server. Possible values are: started, stopped or standby.
Tags List<string>: The tags associated with the server.
Type string: The commercial type of the server. You find all the available types on the pricing page.
UserData Dictionary<string, string>: The user data associated with the server.
Name string
ServerId string
Zone string

AdditionalVolumeIds []string: The additional volumes attached to the server.
BootType string
BootscriptId string
CloudInit string: The cloud init script associated with this server.
EnableDynamicIp bool: True is dynamic IP in enable on the server.
EnableIpv6 bool: Determines if IPv6 is enabled for the server.
Id string: The provider-assigned unique ID for this managed resource.
Image string: The UUID and the label of the base image used by the server.
IpId string
Ipv6Address string: The default ipv6 address routed to the server. ( Only set when enable_ipv6 is set to true )
Ipv6Gateway string: The ipv6 gateway address. ( Only set when enable_ipv6 is set to true )
Ipv6PrefixLength int: The prefix length of the ipv6 subnet routed to the server. ( Only set when enable_ipv6 is set to true )
OrganizationId string: The ID of the organization the server is associated with.
PlacementGroupId string: The placement group the server is attached to.
PlacementGroupPolicyRespected bool: True when the placement group policy is respected.
PrivateIp string: The Scaleway internal IP address of the server.
PrivateNetworks []GetInstanceServerPrivateNetwork
ProjectId string: The ID of the project the server is associated with.
PublicIp string: The public IPv4 address of the server.
RootVolumes []GetInstanceServerRootVolume: Root volume attached to the server on creation.
SecurityGroupId string: The security group the server is attached to.
State string: The state of the server. Possible values are: started, stopped or standby.
Tags []string: The tags associated with the server.
Type string: The commercial type of the server. You find all the available types on the pricing page.
UserData map[string]string: The user data associated with the server.
Name string
ServerId string
Zone string

additionalVolumeIds List<String>: The additional volumes attached to the server.
bootType String
bootscriptId String
cloudInit String: The cloud init script associated with this server.
enableDynamicIp Boolean: True is dynamic IP in enable on the server.
enableIpv6 Boolean: Determines if IPv6 is enabled for the server.
id String: The provider-assigned unique ID for this managed resource.
image String: The UUID and the label of the base image used by the server.
ipId String
ipv6Address String: The default ipv6 address routed to the server. ( Only set when enable_ipv6 is set to true )
ipv6Gateway String: The ipv6 gateway address. ( Only set when enable_ipv6 is set to true )
ipv6PrefixLength Integer: The prefix length of the ipv6 subnet routed to the server. ( Only set when enable_ipv6 is set to true )
organizationId String: The ID of the organization the server is associated with.
placementGroupId String: The placement group the server is attached to.
placementGroupPolicyRespected Boolean: True when the placement group policy is respected.
privateIp String: The Scaleway internal IP address of the server.
privateNetworks List<GetInstanceServerPrivateNetwork>
projectId String: The ID of the project the server is associated with.
publicIp String: The public IPv4 address of the server.
rootVolumes List<GetInstanceServerRootVolume>: Root volume attached to the server on creation.
securityGroupId String: The security group the server is attached to.
state String: The state of the server. Possible values are: started, stopped or standby.
tags List<String>: The tags associated with the server.
type String: The commercial type of the server. You find all the available types on the pricing page.
userData Map<String,String>: The user data associated with the server.
name String
serverId String
zone String

additionalVolumeIds string[]: The additional volumes attached to the server.
bootType string
bootscriptId string
cloudInit string: The cloud init script associated with this server.
enableDynamicIp boolean: True is dynamic IP in enable on the server.
enableIpv6 boolean: Determines if IPv6 is enabled for the server.
id string: The provider-assigned unique ID for this managed resource.
image string: The UUID and the label of the base image used by the server.
ipId string
ipv6Address string: The default ipv6 address routed to the server. ( Only set when enable_ipv6 is set to true )
ipv6Gateway string: The ipv6 gateway address. ( Only set when enable_ipv6 is set to true )
ipv6PrefixLength number: The prefix length of the ipv6 subnet routed to the server. ( Only set when enable_ipv6 is set to true )
organizationId string: The ID of the organization the server is associated with.
placementGroupId string: The placement group the server is attached to.
placementGroupPolicyRespected boolean: True when the placement group policy is respected.
privateIp string: The Scaleway internal IP address of the server.
privateNetworks GetInstanceServerPrivateNetwork[]
projectId string: The ID of the project the server is associated with.
publicIp string: The public IPv4 address of the server.
rootVolumes GetInstanceServerRootVolume[]: Root volume attached to the server on creation.
securityGroupId string: The security group the server is attached to.
state string: The state of the server. Possible values are: started, stopped or standby.
tags string[]: The tags associated with the server.
type string: The commercial type of the server. You find all the available types on the pricing page.
userData {[key: string]: string}: The user data associated with the server.
name string
serverId string
zone string

additional_volume_ids Sequence[str]: The additional volumes attached to the server.
boot_type str
bootscript_id str
cloud_init str: The cloud init script associated with this server.
enable_dynamic_ip bool: True is dynamic IP in enable on the server.
enable_ipv6 bool: Determines if IPv6 is enabled for the server.
id str: The provider-assigned unique ID for this managed resource.
image str: The UUID and the label of the base image used by the server.
ip_id str
ipv6_address str: The default ipv6 address routed to the server. ( Only set when enable_ipv6 is set to true )
ipv6_gateway str: The ipv6 gateway address. ( Only set when enable_ipv6 is set to true )
ipv6_prefix_length int: The prefix length of the ipv6 subnet routed to the server. ( Only set when enable_ipv6 is set to true )
organization_id str: The ID of the organization the server is associated with.
placement_group_id str: The placement group the server is attached to.
placement_group_policy_respected bool: True when the placement group policy is respected.
private_ip str: The Scaleway internal IP address of the server.
private_networks Sequence[GetInstanceServerPrivateNetwork]
project_id str: The ID of the project the server is associated with.
public_ip str: The public IPv4 address of the server.
root_volumes Sequence[GetInstanceServerRootVolume]: Root volume attached to the server on creation.
security_group_id str: The security group the server is attached to.
state str: The state of the server. Possible values are: started, stopped or standby.
tags Sequence[str]: The tags associated with the server.
type str: The commercial type of the server. You find all the available types on the pricing page.
user_data Mapping[str, str]: The user data associated with the server.
name str
server_id str
zone str

additionalVolumeIds List<String>: The additional volumes attached to the server.
bootType String
bootscriptId String
cloudInit String: The cloud init script associated with this server.
enableDynamicIp Boolean: True is dynamic IP in enable on the server.
enableIpv6 Boolean: Determines if IPv6 is enabled for the server.
id String: The provider-assigned unique ID for this managed resource.
image String: The UUID and the label of the base image used by the server.
ipId String
ipv6Address String: The default ipv6 address routed to the server. ( Only set when enable_ipv6 is set to true )
ipv6Gateway String: The ipv6 gateway address. ( Only set when enable_ipv6 is set to true )
ipv6PrefixLength Number: The prefix length of the ipv6 subnet routed to the server. ( Only set when enable_ipv6 is set to true )
organizationId String: The ID of the organization the server is associated with.
placementGroupId String: The placement group the server is attached to.
placementGroupPolicyRespected Boolean: True when the placement group policy is respected.
privateIp String: The Scaleway internal IP address of the server.
privateNetworks List<Property Map>
projectId String: The ID of the project the server is associated with.
publicIp String: The public IPv4 address of the server.
rootVolumes List<Property Map>: Root volume attached to the server on creation.
securityGroupId String: The security group the server is attached to.
state String: The state of the server. Possible values are: started, stopped or standby.
tags List<String>: The tags associated with the server.
type String: The commercial type of the server. You find all the available types on the pricing page.
userData Map<String>: The user data associated with the server.
name String
serverId String
zone String

Supporting Types

GetInstanceServerPrivateNetwork

MacAddress string
PnId string
Status string
Zone string: zone) The zone in which the server exists.

MacAddress string
PnId string
Status string
Zone string: zone) The zone in which the server exists.

macAddress String
pnId String
status String
zone String: zone) The zone in which the server exists.

macAddress string
pnId string
status string
zone string: zone) The zone in which the server exists.

mac_address str
pn_id str
status str
zone str: zone) The zone in which the server exists.

macAddress String
pnId String
status String
zone String: zone) The zone in which the server exists.

GetInstanceServerRootVolume

Boot bool
DeleteOnTermination bool: Forces deletion of the root volume on instance termination.
Name string: The server name. Only one of name and server_id should be specified.
SizeInGb int: Size of the root volume in gigabytes.
VolumeId string: The volume ID of the root volume of the server.
VolumeType string

Boot bool
DeleteOnTermination bool: Forces deletion of the root volume on instance termination.
Name string: The server name. Only one of name and server_id should be specified.
SizeInGb int: Size of the root volume in gigabytes.
VolumeId string: The volume ID of the root volume of the server.
VolumeType string

boot Boolean
deleteOnTermination Boolean: Forces deletion of the root volume on instance termination.
name String: The server name. Only one of name and server_id should be specified.
sizeInGb Integer: Size of the root volume in gigabytes.
volumeId String: The volume ID of the root volume of the server.
volumeType String

boot boolean
deleteOnTermination boolean: Forces deletion of the root volume on instance termination.
name string: The server name. Only one of name and server_id should be specified.
sizeInGb number: Size of the root volume in gigabytes.
volumeId string: The volume ID of the root volume of the server.
volumeType string

boot bool
delete_on_termination bool: Forces deletion of the root volume on instance termination.
name str: The server name. Only one of name and server_id should be specified.
size_in_gb int: Size of the root volume in gigabytes.
volume_id str: The volume ID of the root volume of the server.
volume_type str

boot Boolean
deleteOnTermination Boolean: Forces deletion of the root volume on instance termination.
name String: The server name. Only one of name and server_id should be specified.
sizeInGb Number: Size of the root volume in gigabytes.
volumeId String: The volume ID of the root volume of the server.
volumeType String

Package Details

Repository: https://github.com/lbrlabs/pulumi-scaleway
License: Apache-2.0
Notes: This Pulumi package is based on the scaleway Terraform Provider.