1. Packages
  2. Scaleway
  3. API Docs
  4. getInstanceServer
Scaleway v1.12.1 published on Monday, Apr 15, 2024 by pulumiverse

scaleway.getInstanceServer

Explore with Pulumi AI

scaleway logo
Scaleway v1.12.1 published on Monday, Apr 15, 2024 by pulumiverse

    Gets information about an instance server.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as scaleway from "@pulumi/scaleway";
    
    const myKey = scaleway.getInstanceServer({
        serverId: "11111111-1111-1111-1111-111111111111",
    });
    
    import pulumi
    import pulumi_scaleway as scaleway
    
    my_key = scaleway.get_instance_server(server_id="11111111-1111-1111-1111-111111111111")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := scaleway.LookupInstanceServer(ctx, &scaleway.LookupInstanceServerArgs{
    			ServerId: pulumi.StringRef("11111111-1111-1111-1111-111111111111"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Scaleway = Pulumi.Scaleway;
    
    return await Deployment.RunAsync(() => 
    {
        var myKey = Scaleway.GetInstanceServer.Invoke(new()
        {
            ServerId = "11111111-1111-1111-1111-111111111111",
        });
    
    });
    
    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());
    
        }
    }
    
    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,
                            project_id: 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,
                            project_id: 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.
    ProjectId string
    The ID of the project the instance server is associated with.
    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.
    ProjectId string
    The ID of the project the instance server is associated with.
    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.
    projectId String
    The ID of the project the instance server is associated with.
    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.
    projectId string
    The ID of the project the instance server is associated with.
    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.
    project_id str
    The ID of the project the instance server is associated with.
    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.
    projectId String
    The ID of the project the instance server is associated with.
    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 if 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
    IpIds List<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<Pulumiverse.Scaleway.Outputs.GetInstanceServerPrivateNetwork>
    PublicIp string
    The public IP address of the server.
    PublicIps List<Pulumiverse.Scaleway.Outputs.GetInstanceServerPublicIp>
    The list of public IPs of the server
    ReplaceOnTypeChange bool
    RootVolumes List<Pulumiverse.Scaleway.Outputs.GetInstanceServerRootVolume>
    RoutedIpEnabled bool
    True if the server support routed ip only.
    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
    ProjectId 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 if 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
    IpIds []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
    PublicIp string
    The public IP address of the server.
    PublicIps []GetInstanceServerPublicIp
    The list of public IPs of the server
    ReplaceOnTypeChange bool
    RootVolumes []GetInstanceServerRootVolume
    RoutedIpEnabled bool
    True if the server support routed ip only.
    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
    ProjectId 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 if 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
    ipIds List<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>
    publicIp String
    The public IP address of the server.
    publicIps List<GetInstanceServerPublicIp>
    The list of public IPs of the server
    replaceOnTypeChange Boolean
    rootVolumes List<GetInstanceServerRootVolume>
    routedIpEnabled Boolean
    True if the server support routed ip only.
    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
    projectId 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 if 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
    ipIds 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[]
    publicIp string
    The public IP address of the server.
    publicIps GetInstanceServerPublicIp[]
    The list of public IPs of the server
    replaceOnTypeChange boolean
    rootVolumes GetInstanceServerRootVolume[]
    routedIpEnabled boolean
    True if the server support routed ip only.
    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
    projectId 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 if 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
    ip_ids Sequence[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]
    public_ip str
    The public IP address of the server.
    public_ips Sequence[GetInstanceServerPublicIp]
    The list of public IPs of the server
    replace_on_type_change bool
    root_volumes Sequence[GetInstanceServerRootVolume]
    routed_ip_enabled bool
    True if the server support routed ip only.
    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
    project_id 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 if 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
    ipIds List<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>
    publicIp String
    The public IP address of the server.
    publicIps List<Property Map>
    The list of public IPs of the server
    replaceOnTypeChange Boolean
    rootVolumes List<Property Map>
    routedIpEnabled Boolean
    True if the server support routed ip only.
    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
    projectId String
    serverId String
    zone String

    Supporting Types

    GetInstanceServerPrivateNetwork

    MacAddress string
    MAC address of the NIC
    PnId string
    The Private Network ID
    Status string
    The private NIC state
    Zone string
    zone) The zone in which the server exists.
    MacAddress string
    MAC address of the NIC
    PnId string
    The Private Network ID
    Status string
    The private NIC state
    Zone string
    zone) The zone in which the server exists.
    macAddress String
    MAC address of the NIC
    pnId String
    The Private Network ID
    status String
    The private NIC state
    zone String
    zone) The zone in which the server exists.
    macAddress string
    MAC address of the NIC
    pnId string
    The Private Network ID
    status string
    The private NIC state
    zone string
    zone) The zone in which the server exists.
    mac_address str
    MAC address of the NIC
    pn_id str
    The Private Network ID
    status str
    The private NIC state
    zone str
    zone) The zone in which the server exists.
    macAddress String
    MAC address of the NIC
    pnId String
    The Private Network ID
    status String
    The private NIC state
    zone String
    zone) The zone in which the server exists.

    GetInstanceServerPublicIp

    Address string
    The address of the IP
    Id string
    The ID of the IP
    Address string
    The address of the IP
    Id string
    The ID of the IP
    address String
    The address of the IP
    id String
    The ID of the IP
    address string
    The address of the IP
    id string
    The ID of the IP
    address str
    The address of the IP
    id str
    The ID of the IP
    address String
    The address of the IP
    id String
    The ID of the IP

    GetInstanceServerRootVolume

    Boot bool
    Set the volume where the boot the server
    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
    Volume type of the root volume
    Boot bool
    Set the volume where the boot the server
    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
    Volume type of the root volume
    boot Boolean
    Set the volume where the boot the server
    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
    Volume type of the root volume
    boot boolean
    Set the volume where the boot the server
    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
    Volume type of the root volume
    boot bool
    Set the volume where the boot the server
    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
    Volume type of the root volume
    boot Boolean
    Set the volume where the boot the server
    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
    Volume type of the root volume

    Package Details

    Repository
    scaleway pulumiverse/pulumi-scaleway
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the scaleway Terraform Provider.
    scaleway logo
    Scaleway v1.12.1 published on Monday, Apr 15, 2024 by pulumiverse