Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Genesis Cloud
  3. API Docs
  4. Instance
Genesis Cloud v0.0.28 published on Tuesday, Sep 3, 2024 by Genesiscloud
genesiscloud/pulumi-genesiscloud

genesiscloud.Instance

Explore with Pulumi AI

genesiscloud logo
Genesis Cloud v0.0.28 published on Tuesday, Sep 3, 2024 by Genesiscloud
genesiscloud/pulumi-genesiscloud

    Instance resource

    Example Usage

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Genesiscloud = GenesisCloud.PulumiPackage.Genesiscloud;

return await Deployment.RunAsync(() => 
{
    var example = new Genesiscloud.Instance("example", new()
    {
        Image = "my-image-id",
        Region = "ARC-IS-HAF-1",
        SshKeyIds = new[]
        {
            "my-ssh-key-id",
        },
        Type = "vcpu-2_memory-4g",
    });

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := genesiscloud.NewInstance(ctx, "example", &genesiscloud.InstanceArgs{
			Image:  pulumi.String("my-image-id"),
			Region: pulumi.String("ARC-IS-HAF-1"),
			SshKeyIds: pulumi.StringArray{
				pulumi.String("my-ssh-key-id"),
			},
			Type: pulumi.String("vcpu-2_memory-4g"),
		})
		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.genesiscloud.Instance;
import com.pulumi.genesiscloud.InstanceArgs;
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) {
        var example = new Instance("example", InstanceArgs.builder()        
            .image("my-image-id")
            .region("ARC-IS-HAF-1")
            .sshKeyIds("my-ssh-key-id")
            .type("vcpu-2_memory-4g")
            .build());

    }
}

    import pulumi
import pulumi_genesiscloud as genesiscloud

example = genesiscloud.Instance("example",
    image="my-image-id",
    region="ARC-IS-HAF-1",
    ssh_key_ids=["my-ssh-key-id"],
    type="vcpu-2_memory-4g")

    import * as pulumi from "@pulumi/pulumi";
import * as genesiscloud from "@genesiscloud/pulumi-genesiscloud";

const example = new genesiscloud.Instance("example", {
    image: "my-image-id",
    region: "ARC-IS-HAF-1",
    sshKeyIds: ["my-ssh-key-id"],
    type: "vcpu-2_memory-4g",
});

    resources:
  example:
    type: genesiscloud:Instance
    properties:
      image: my-image-id
      region: ARC-IS-HAF-1
      sshKeyIds:
        - my-ssh-key-id
      type: vcpu-2_memory-4g

    Create Instance Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Instance(name: string, args: InstanceArgs, opts?: CustomResourceOptions);
    @overload
def Instance(resource_name: str,
             args: InstanceArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Instance(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             image: Optional[str] = None,
             type: Optional[str] = None,
             region: Optional[str] = None,
             password: Optional[str] = None,
             metadata: Optional[InstanceMetadataArgs] = None,
             name: Optional[str] = None,
             disk_size: Optional[int] = None,
             placement_option: Optional[str] = None,
             hostname: Optional[str] = None,
             reservation_id: Optional[str] = None,
             security_group_ids: Optional[Sequence[str]] = None,
             ssh_key_ids: Optional[Sequence[str]] = None,
             timeouts: Optional[InstanceTimeoutsArgs] = None,
             floating_ip_id: Optional[str] = None,
             volume_ids: Optional[Sequence[str]] = None)
    func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)
    public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)
    public Instance(String name, InstanceArgs args)
public Instance(String name, InstanceArgs args, CustomResourceOptions options)

    type: genesiscloud:Instance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var instanceResource = new Genesiscloud.Instance("instanceResource", new()
{
    Image = "string",
    Type = "string",
    Region = "string",
    Password = "string",
    Metadata = new Genesiscloud.Inputs.InstanceMetadataArgs
    {
        StartupScript = "string",
    },
    Name = "string",
    DiskSize = 0,
    PlacementOption = "string",
    Hostname = "string",
    ReservationId = "string",
    SecurityGroupIds = new[]
    {
        "string",
    },
    SshKeyIds = new[]
    {
        "string",
    },
    Timeouts = new Genesiscloud.Inputs.InstanceTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Read = "string",
        Update = "string",
    },
    FloatingIpId = "string",
    VolumeIds = new[]
    {
        "string",
    },
});

    example, err := genesiscloud.NewInstance(ctx, "instanceResource", &genesiscloud.InstanceArgs{
	Image:    pulumi.String("string"),
	Type:     pulumi.String("string"),
	Region:   pulumi.String("string"),
	Password: pulumi.String("string"),
	Metadata: &genesiscloud.InstanceMetadataArgs{
		StartupScript: pulumi.String("string"),
	},
	Name:            pulumi.String("string"),
	DiskSize:        pulumi.Int(0),
	PlacementOption: pulumi.String("string"),
	Hostname:        pulumi.String("string"),
	ReservationId:   pulumi.String("string"),
	SecurityGroupIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	SshKeyIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Timeouts: &genesiscloud.InstanceTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Read:   pulumi.String("string"),
		Update: pulumi.String("string"),
	},
	FloatingIpId: pulumi.String("string"),
	VolumeIds: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var instanceResource = new Instance("instanceResource", InstanceArgs.builder()
    .image("string")
    .type("string")
    .region("string")
    .password("string")
    .metadata(InstanceMetadataArgs.builder()
        .startupScript("string")
        .build())
    .name("string")
    .diskSize(0)
    .placementOption("string")
    .hostname("string")
    .reservationId("string")
    .securityGroupIds("string")
    .sshKeyIds("string")
    .timeouts(InstanceTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .read("string")
        .update("string")
        .build())
    .floatingIpId("string")
    .volumeIds("string")
    .build());

    instance_resource = genesiscloud.Instance("instanceResource",
    image="string",
    type="string",
    region="string",
    password="string",
    metadata=genesiscloud.InstanceMetadataArgs(
        startup_script="string",
    ),
    name="string",
    disk_size=0,
    placement_option="string",
    hostname="string",
    reservation_id="string",
    security_group_ids=["string"],
    ssh_key_ids=["string"],
    timeouts=genesiscloud.InstanceTimeoutsArgs(
        create="string",
        delete="string",
        read="string",
        update="string",
    ),
    floating_ip_id="string",
    volume_ids=["string"])

    const instanceResource = new genesiscloud.Instance("instanceResource", {
    image: "string",
    type: "string",
    region: "string",
    password: "string",
    metadata: {
        startupScript: "string",
    },
    name: "string",
    diskSize: 0,
    placementOption: "string",
    hostname: "string",
    reservationId: "string",
    securityGroupIds: ["string"],
    sshKeyIds: ["string"],
    timeouts: {
        create: "string",
        "delete": "string",
        read: "string",
        update: "string",
    },
    floatingIpId: "string",
    volumeIds: ["string"],
});

    type: genesiscloud:Instance
properties:
    diskSize: 0
    floatingIpId: string
    hostname: string
    image: string
    metadata:
        startupScript: string
    name: string
    password: string
    placementOption: string
    region: string
    reservationId: string
    securityGroupIds:
        - string
    sshKeyIds:
        - string
    timeouts:
        create: string
        delete: string
        read: string
        update: string
    type: string
    volumeIds:
        - string

    Instance Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Instance resource accepts the following input properties:

    Image string
    The source image id, image slug or snapshot id of the instance. The image version can also specified together with the image slug in this format <image-slug>:<version>. Learn more about images here. - If the value of this attribute changes, Terraform will destroy and recreate the resource.
    Region string
    The region identifier. - If the value of this attribute changes, Terraform will destroy and recreate the resource. - The value must be one of: ["ARC-IS-HAF-1" "EUC-DE-MUC-1" "NORD-NO-KRS-1"].
    Type string
    The instance type identifier. Learn more about instance types here. - If the value of this attribute changes, Terraform will destroy and recreate the resource.
    DiskSize int
    The disk size of the instance in GB.
    FloatingIpId string
    The floating IP attached to the instance.
    Hostname string
    The hostname of your instance. If not provided will be initially set to the name attribute. - If the value of this attribute is configured and changes, Terraform will destroy and recreate the resource.
    Metadata GenesisCloud.PulumiPackage.Genesiscloud.Inputs.InstanceMetadata
    Option to provide metadata. Currently supported is startup_script.
    Name string
    The human-readable name for the instance.
    Password string
    The password to access the instance. Your password must have upper and lower chars, digits and length between 8-72. Please Note: Only one of ssh_keys or password can be provided. Password is less secure - we recommend you use an SSH key-pair. - If the value of this attribute changes, Terraform will destroy and recreate the resource. - The string length must be at least 16.
    PlacementOption string
    The placement option identifier in which instances are physically located relative to each other within a zone. For example A or B. - If the value of this attribute changes, Terraform will destroy and recreate the resource.
    ReservationId string
    The id of the reservation the instance is associated with.
    SecurityGroupIds List<string>
    The security groups of the instance. If not provided will be set to the default security group.
    SshKeyIds List<string>
    The ssh keys of the instance. - If the value of this attribute changes, Terraform will destroy and recreate the resource.
    Timeouts GenesisCloud.PulumiPackage.Genesiscloud.Inputs.InstanceTimeouts
    VolumeIds List<string>
    The volumes of the instance.
    Image string
    The source image id, image slug or snapshot id of the instance. The image version can also specified together with the image slug in this format <image-slug>:<version>. Learn more about images here. - If the value of this attribute changes, Terraform will destroy and recreate the resource.
    Region string
    The region identifier. - If the value of this attribute changes, Terraform will destroy and recreate the resource. - The value must be one of: ["ARC-IS-HAF-1" "EUC-DE-MUC-1" "NORD-NO-KRS-1"].
    Type string
    The instance type identifier. Learn more about instance types here. - If the value of this attribute changes, Terraform will destroy and recreate the resource.
    DiskSize int
    The disk size of the instance in GB.
    FloatingIpId string
    The floating IP attached to the instance.
    Hostname string
    The hostname of your instance. If not provided will be initially set to the name attribute. - If the value of this attribute is configured and changes, Terraform will destroy and recreate the resource.
    Metadata InstanceMetadataArgs
    Option to provide metadata. Currently supported is startup_script.
    Name string
    The human-readable name for the instance.
    Password string
    The password to access the instance. Your password must have upper and lower chars, digits and length between 8-72. Please Note: Only one of ssh_keys or password can be provided. Password is less secure - we recommend you use an SSH key-pair. - If the value of this attribute changes, Terraform will destroy and recreate the resource. - The string length must be at least 16.
    PlacementOption string
    The placement option identifier in which instances are physically located relative to each other within a zone. For example A or B. - If the value of this attribute changes, Terraform will destroy and recreate the resource.
    ReservationId string
    The id of the reservation the instance is associated with.
    SecurityGroupIds []string
    The security groups of the instance. If not provided will be set to the default security group.
    SshKeyIds []string
    The ssh keys of the instance. - If the value of this attribute changes, Terraform will destroy and recreate the resource.
    Timeouts InstanceTimeoutsArgs
    VolumeIds []string
    The volumes of the instance.
    image String
    The source image id, image slug or snapshot id of the instance. The image version can also specified together with the image slug in this format <image-slug>:<version>. Learn more about images here. - If the value of this attribute changes, Terraform will destroy and recreate the resource.
    region String
    The region identifier. - If the value of this attribute changes, Terraform will destroy and recreate the resource. - The value must be one of: ["ARC-IS-HAF-1" "EUC-DE-MUC-1" "NORD-NO-KRS-1"].
    type String
    The instance type identifier. Learn more about instance types here. - If the value of this attribute changes, Terraform will destroy and recreate the resource.
    diskSize Integer
    The disk size of the instance in GB.
    floatingIpId String
    The floating IP attached to the instance.
    hostname String
    The hostname of your instance. If not provided will be initially set to the name attribute. - If the value of this attribute is configured and changes, Terraform will destroy and recreate the resource.
    metadata InstanceMetadata
    Option to provide metadata. Currently supported is startup_script.
    name String
    The human-readable name for the instance.
    password String
    The password to access the instance. Your password must have upper and lower chars, digits and length between 8-72. Please Note: Only one of ssh_keys or password can be provided. Password is less secure - we recommend you use an SSH key-pair. - If the value of this attribute changes, Terraform will destroy and recreate the resource. - The string length must be at least 16.
    placementOption String
    The placement option identifier in which instances are physically located relative to each other within a zone. For example A or B. - If the value of this attribute changes, Terraform will destroy and recreate the resource.
    reservationId String
    The id of the reservation the instance is associated with.
    securityGroupIds List<String>
    The security groups of the instance. If not provided will be set to the default security group.
    sshKeyIds List<String>
    The ssh keys of the instance. - If the value of this attribute changes, Terraform will destroy and recreate the resource.
    timeouts InstanceTimeouts
    volumeIds List<String>
    The volumes of the instance.
    image string
    The source image id, image slug or snapshot id of the instance. The image version can also specified together with the image slug in this format <image-slug>:<version>. Learn more about images here. - If the value of this attribute changes, Terraform will destroy and recreate the resource.
    region string
    The region identifier. - If the value of this attribute changes, Terraform will destroy and recreate the resource. - The value must be one of: ["ARC-IS-HAF-1" "EUC-DE-MUC-1" "NORD-NO-KRS-1"].
    type string
    The instance type identifier. Learn more about instance types here. - If the value of this attribute changes, Terraform will destroy and recreate the resource.
    diskSize number
    The disk size of the instance in GB.
    floatingIpId string
    The floating IP attached to the instance.
    hostname string
    The hostname of your instance. If not provided will be initially set to the name attribute. - If the value of this attribute is configured and changes, Terraform will destroy and recreate the resource.
    metadata InstanceMetadata
    Option to provide metadata. Currently supported is startup_script.
    name string
    The human-readable name for the instance.
    password string
    The password to access the instance. Your password must have upper and lower chars, digits and length between 8-72. Please Note: Only one of ssh_keys or password can be provided. Password is less secure - we recommend you use an SSH key-pair. - If the value of this attribute changes, Terraform will destroy and recreate the resource. - The string length must be at least 16.
    placementOption string
    The placement option identifier in which instances are physically located relative to each other within a zone. For example A or B. - If the value of this attribute changes, Terraform will destroy and recreate the resource.
    reservationId string
    The id of the reservation the instance is associated with.
    securityGroupIds string[]
    The security groups of the instance. If not provided will be set to the default security group.
    sshKeyIds string[]
    The ssh keys of the instance. - If the value of this attribute changes, Terraform will destroy and recreate the resource.
    timeouts InstanceTimeouts
    volumeIds string[]
    The volumes of the instance.
    image str
    The source image id, image slug or snapshot id of the instance. The image version can also specified together with the image slug in this format <image-slug>:<version>. Learn more about images here. - If the value of this attribute changes, Terraform will destroy and recreate the resource.
    region str
    The region identifier. - If the value of this attribute changes, Terraform will destroy and recreate the resource. - The value must be one of: ["ARC-IS-HAF-1" "EUC-DE-MUC-1" "NORD-NO-KRS-1"].
    type str
    The instance type identifier. Learn more about instance types here. - If the value of this attribute changes, Terraform will destroy and recreate the resource.
    disk_size int
    The disk size of the instance in GB.
    floating_ip_id str
    The floating IP attached to the instance.
    hostname str
    The hostname of your instance. If not provided will be initially set to the name attribute. - If the value of this attribute is configured and changes, Terraform will destroy and recreate the resource.
    metadata InstanceMetadataArgs
    Option to provide metadata. Currently supported is startup_script.
    name str
    The human-readable name for the instance.
    password str
    The password to access the instance. Your password must have upper and lower chars, digits and length between 8-72. Please Note: Only one of ssh_keys or password can be provided. Password is less secure - we recommend you use an SSH key-pair. - If the value of this attribute changes, Terraform will destroy and recreate the resource. - The string length must be at least 16.
    placement_option str
    The placement option identifier in which instances are physically located relative to each other within a zone. For example A or B. - If the value of this attribute changes, Terraform will destroy and recreate the resource.
    reservation_id str
    The id of the reservation the instance is associated with.
    security_group_ids Sequence[str]
    The security groups of the instance. If not provided will be set to the default security group.
    ssh_key_ids Sequence[str]
    The ssh keys of the instance. - If the value of this attribute changes, Terraform will destroy and recreate the resource.
    timeouts InstanceTimeoutsArgs
    volume_ids Sequence[str]
    The volumes of the instance.
    image String
    The source image id, image slug or snapshot id of the instance. The image version can also specified together with the image slug in this format <image-slug>:<version>. Learn more about images here. - If the value of this attribute changes, Terraform will destroy and recreate the resource.
    region String
    The region identifier. - If the value of this attribute changes, Terraform will destroy and recreate the resource. - The value must be one of: ["ARC-IS-HAF-1" "EUC-DE-MUC-1" "NORD-NO-KRS-1"].
    type String
    The instance type identifier. Learn more about instance types here. - If the value of this attribute changes, Terraform will destroy and recreate the resource.
    diskSize Number
    The disk size of the instance in GB.
    floatingIpId String
    The floating IP attached to the instance.
    hostname String
    The hostname of your instance. If not provided will be initially set to the name attribute. - If the value of this attribute is configured and changes, Terraform will destroy and recreate the resource.
    metadata Property Map
    Option to provide metadata. Currently supported is startup_script.
    name String
    The human-readable name for the instance.
    password String
    The password to access the instance. Your password must have upper and lower chars, digits and length between 8-72. Please Note: Only one of ssh_keys or password can be provided. Password is less secure - we recommend you use an SSH key-pair. - If the value of this attribute changes, Terraform will destroy and recreate the resource. - The string length must be at least 16.
    placementOption String
    The placement option identifier in which instances are physically located relative to each other within a zone. For example A or B. - If the value of this attribute changes, Terraform will destroy and recreate the resource.
    reservationId String
    The id of the reservation the instance is associated with.
    securityGroupIds List<String>
    The security groups of the instance. If not provided will be set to the default security group.
    sshKeyIds List<String>
    The ssh keys of the instance. - If the value of this attribute changes, Terraform will destroy and recreate the resource.
    timeouts Property Map
    volumeIds List<String>
    The volumes of the instance.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Instance resource produces the following output properties:

    CreatedAt string
    The timestamp when this image was created in RFC 3339.
    DnsName string
    The dns name of the instance.
    Id string
    The provider-assigned unique ID for this managed resource.
    ImageId string
    The resulting image ID of the instance.
    PrivateIp string
    The private IPv4 IP-Address (IPv4 address).
    PublicIp string
    The public IPv4 IP-Address (IPv4 address).
    Status string
    The instance status.
    UpdatedAt string
    The timestamp when this image was last updated in RFC 3339.
    CreatedAt string
    The timestamp when this image was created in RFC 3339.
    DnsName string
    The dns name of the instance.
    Id string
    The provider-assigned unique ID for this managed resource.
    ImageId string
    The resulting image ID of the instance.
    PrivateIp string
    The private IPv4 IP-Address (IPv4 address).
    PublicIp string
    The public IPv4 IP-Address (IPv4 address).
    Status string
    The instance status.
    UpdatedAt string
    The timestamp when this image was last updated in RFC 3339.
    createdAt String
    The timestamp when this image was created in RFC 3339.
    dnsName String
    The dns name of the instance.
    id String
    The provider-assigned unique ID for this managed resource.
    imageId String
    The resulting image ID of the instance.
    privateIp String
    The private IPv4 IP-Address (IPv4 address).
    publicIp String
    The public IPv4 IP-Address (IPv4 address).
    status String
    The instance status.
    updatedAt String
    The timestamp when this image was last updated in RFC 3339.
    createdAt string
    The timestamp when this image was created in RFC 3339.
    dnsName string
    The dns name of the instance.
    id string
    The provider-assigned unique ID for this managed resource.
    imageId string
    The resulting image ID of the instance.
    privateIp string
    The private IPv4 IP-Address (IPv4 address).
    publicIp string
    The public IPv4 IP-Address (IPv4 address).
    status string
    The instance status.
    updatedAt string
    The timestamp when this image was last updated in RFC 3339.
    created_at str
    The timestamp when this image was created in RFC 3339.
    dns_name str
    The dns name of the instance.
    id str
    The provider-assigned unique ID for this managed resource.
    image_id str
    The resulting image ID of the instance.
    private_ip str
    The private IPv4 IP-Address (IPv4 address).
    public_ip str
    The public IPv4 IP-Address (IPv4 address).
    status str
    The instance status.
    updated_at str
    The timestamp when this image was last updated in RFC 3339.
    createdAt String
    The timestamp when this image was created in RFC 3339.
    dnsName String
    The dns name of the instance.
    id String
    The provider-assigned unique ID for this managed resource.
    imageId String
    The resulting image ID of the instance.
    privateIp String
    The private IPv4 IP-Address (IPv4 address).
    publicIp String
    The public IPv4 IP-Address (IPv4 address).
    status String
    The instance status.
    updatedAt String
    The timestamp when this image was last updated in RFC 3339.

    Look up Existing Instance Resource

    Get an existing Instance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: InstanceState, opts?: CustomResourceOptions): Instance
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_at: Optional[str] = None,
        disk_size: Optional[int] = None,
        dns_name: Optional[str] = None,
        floating_ip_id: Optional[str] = None,
        hostname: Optional[str] = None,
        image: Optional[str] = None,
        image_id: Optional[str] = None,
        metadata: Optional[InstanceMetadataArgs] = None,
        name: Optional[str] = None,
        password: Optional[str] = None,
        placement_option: Optional[str] = None,
        private_ip: Optional[str] = None,
        public_ip: Optional[str] = None,
        region: Optional[str] = None,
        reservation_id: Optional[str] = None,
        security_group_ids: Optional[Sequence[str]] = None,
        ssh_key_ids: Optional[Sequence[str]] = None,
        status: Optional[str] = None,
        timeouts: Optional[InstanceTimeoutsArgs] = None,
        type: Optional[str] = None,
        updated_at: Optional[str] = None,
        volume_ids: Optional[Sequence[str]] = None) -> Instance
    func GetInstance(ctx *Context, name string, id IDInput, state *InstanceState, opts ...ResourceOption) (*Instance, error)
    public static Instance Get(string name, Input<string> id, InstanceState? state, CustomResourceOptions? opts = null)
    public static Instance get(String name, Output<String> id, InstanceState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CreatedAt string
    The timestamp when this image was created in RFC 3339.
    DiskSize int
    The disk size of the instance in GB.
    DnsName string
    The dns name of the instance.
    FloatingIpId string
    The floating IP attached to the instance.
    Hostname string
    The hostname of your instance. If not provided will be initially set to the name attribute. - If the value of this attribute is configured and changes, Terraform will destroy and recreate the resource.
    Image string
    The source image id, image slug or snapshot id of the instance. The image version can also specified together with the image slug in this format <image-slug>:<version>. Learn more about images here. - If the value of this attribute changes, Terraform will destroy and recreate the resource.
    ImageId string
    The resulting image ID of the instance.
    Metadata GenesisCloud.PulumiPackage.Genesiscloud.Inputs.InstanceMetadata
    Option to provide metadata. Currently supported is startup_script.
    Name string
    The human-readable name for the instance.
    Password string
    The password to access the instance. Your password must have upper and lower chars, digits and length between 8-72. Please Note: Only one of ssh_keys or password can be provided. Password is less secure - we recommend you use an SSH key-pair. - If the value of this attribute changes, Terraform will destroy and recreate the resource. - The string length must be at least 16.
    PlacementOption string
    The placement option identifier in which instances are physically located relative to each other within a zone. For example A or B. - If the value of this attribute changes, Terraform will destroy and recreate the resource.
    PrivateIp string
    The private IPv4 IP-Address (IPv4 address).
    PublicIp string
    The public IPv4 IP-Address (IPv4 address).
    Region string
    The region identifier. - If the value of this attribute changes, Terraform will destroy and recreate the resource. - The value must be one of: ["ARC-IS-HAF-1" "EUC-DE-MUC-1" "NORD-NO-KRS-1"].
    ReservationId string
    The id of the reservation the instance is associated with.
    SecurityGroupIds List<string>
    The security groups of the instance. If not provided will be set to the default security group.
    SshKeyIds List<string>
    The ssh keys of the instance. - If the value of this attribute changes, Terraform will destroy and recreate the resource.
    Status string
    The instance status.
    Timeouts GenesisCloud.PulumiPackage.Genesiscloud.Inputs.InstanceTimeouts
    Type string
    The instance type identifier. Learn more about instance types here. - If the value of this attribute changes, Terraform will destroy and recreate the resource.
    UpdatedAt string
    The timestamp when this image was last updated in RFC 3339.
    VolumeIds List<string>
    The volumes of the instance.
    CreatedAt string
    The timestamp when this image was created in RFC 3339.
    DiskSize int
    The disk size of the instance in GB.
    DnsName string
    The dns name of the instance.
    FloatingIpId string
    The floating IP attached to the instance.
    Hostname string
    The hostname of your instance. If not provided will be initially set to the name attribute. - If the value of this attribute is configured and changes, Terraform will destroy and recreate the resource.
    Image string
    The source image id, image slug or snapshot id of the instance. The image version can also specified together with the image slug in this format <image-slug>:<version>. Learn more about images here. - If the value of this attribute changes, Terraform will destroy and recreate the resource.
    ImageId string
    The resulting image ID of the instance.
    Metadata InstanceMetadataArgs
    Option to provide metadata. Currently supported is startup_script.
    Name string
    The human-readable name for the instance.
    Password string
    The password to access the instance. Your password must have upper and lower chars, digits and length between 8-72. Please Note: Only one of ssh_keys or password can be provided. Password is less secure - we recommend you use an SSH key-pair. - If the value of this attribute changes, Terraform will destroy and recreate the resource. - The string length must be at least 16.
    PlacementOption string
    The placement option identifier in which instances are physically located relative to each other within a zone. For example A or B. - If the value of this attribute changes, Terraform will destroy and recreate the resource.
    PrivateIp string
    The private IPv4 IP-Address (IPv4 address).
    PublicIp string
    The public IPv4 IP-Address (IPv4 address).
    Region string
    The region identifier. - If the value of this attribute changes, Terraform will destroy and recreate the resource. - The value must be one of: ["ARC-IS-HAF-1" "EUC-DE-MUC-1" "NORD-NO-KRS-1"].
    ReservationId string
    The id of the reservation the instance is associated with.
    SecurityGroupIds []string
    The security groups of the instance. If not provided will be set to the default security group.
    SshKeyIds []string
    The ssh keys of the instance. - If the value of this attribute changes, Terraform will destroy and recreate the resource.
    Status string
    The instance status.
    Timeouts InstanceTimeoutsArgs
    Type string
    The instance type identifier. Learn more about instance types here. - If the value of this attribute changes, Terraform will destroy and recreate the resource.
    UpdatedAt string
    The timestamp when this image was last updated in RFC 3339.
    VolumeIds []string
    The volumes of the instance.
    createdAt String
    The timestamp when this image was created in RFC 3339.
    diskSize Integer
    The disk size of the instance in GB.
    dnsName String
    The dns name of the instance.
    floatingIpId String
    The floating IP attached to the instance.
    hostname String
    The hostname of your instance. If not provided will be initially set to the name attribute. - If the value of this attribute is configured and changes, Terraform will destroy and recreate the resource.
    image String
    The source image id, image slug or snapshot id of the instance. The image version can also specified together with the image slug in this format <image-slug>:<version>. Learn more about images here. - If the value of this attribute changes, Terraform will destroy and recreate the resource.
    imageId String
    The resulting image ID of the instance.
    metadata InstanceMetadata
    Option to provide metadata. Currently supported is startup_script.
    name String
    The human-readable name for the instance.
    password String
    The password to access the instance. Your password must have upper and lower chars, digits and length between 8-72. Please Note: Only one of ssh_keys or password can be provided. Password is less secure - we recommend you use an SSH key-pair. - If the value of this attribute changes, Terraform will destroy and recreate the resource. - The string length must be at least 16.
    placementOption String
    The placement option identifier in which instances are physically located relative to each other within a zone. For example A or B. - If the value of this attribute changes, Terraform will destroy and recreate the resource.
    privateIp String
    The private IPv4 IP-Address (IPv4 address).
    publicIp String
    The public IPv4 IP-Address (IPv4 address).
    region String
    The region identifier. - If the value of this attribute changes, Terraform will destroy and recreate the resource. - The value must be one of: ["ARC-IS-HAF-1" "EUC-DE-MUC-1" "NORD-NO-KRS-1"].
    reservationId String
    The id of the reservation the instance is associated with.
    securityGroupIds List<String>
    The security groups of the instance. If not provided will be set to the default security group.
    sshKeyIds List<String>
    The ssh keys of the instance. - If the value of this attribute changes, Terraform will destroy and recreate the resource.
    status String
    The instance status.
    timeouts InstanceTimeouts
    type String
    The instance type identifier. Learn more about instance types here. - If the value of this attribute changes, Terraform will destroy and recreate the resource.
    updatedAt String
    The timestamp when this image was last updated in RFC 3339.
    volumeIds List<String>
    The volumes of the instance.
    createdAt string
    The timestamp when this image was created in RFC 3339.
    diskSize number
    The disk size of the instance in GB.
    dnsName string
    The dns name of the instance.
    floatingIpId string
    The floating IP attached to the instance.
    hostname string
    The hostname of your instance. If not provided will be initially set to the name attribute. - If the value of this attribute is configured and changes, Terraform will destroy and recreate the resource.
    image string
    The source image id, image slug or snapshot id of the instance. The image version can also specified together with the image slug in this format <image-slug>:<version>. Learn more about images here. - If the value of this attribute changes, Terraform will destroy and recreate the resource.
    imageId string
    The resulting image ID of the instance.
    metadata InstanceMetadata
    Option to provide metadata. Currently supported is startup_script.
    name string
    The human-readable name for the instance.
    password string
    The password to access the instance. Your password must have upper and lower chars, digits and length between 8-72. Please Note: Only one of ssh_keys or password can be provided. Password is less secure - we recommend you use an SSH key-pair. - If the value of this attribute changes, Terraform will destroy and recreate the resource. - The string length must be at least 16.
    placementOption string
    The placement option identifier in which instances are physically located relative to each other within a zone. For example A or B. - If the value of this attribute changes, Terraform will destroy and recreate the resource.
    privateIp string
    The private IPv4 IP-Address (IPv4 address).
    publicIp string
    The public IPv4 IP-Address (IPv4 address).
    region string
    The region identifier. - If the value of this attribute changes, Terraform will destroy and recreate the resource. - The value must be one of: ["ARC-IS-HAF-1" "EUC-DE-MUC-1" "NORD-NO-KRS-1"].
    reservationId string
    The id of the reservation the instance is associated with.
    securityGroupIds string[]
    The security groups of the instance. If not provided will be set to the default security group.
    sshKeyIds string[]
    The ssh keys of the instance. - If the value of this attribute changes, Terraform will destroy and recreate the resource.
    status string
    The instance status.
    timeouts InstanceTimeouts
    type string
    The instance type identifier. Learn more about instance types here. - If the value of this attribute changes, Terraform will destroy and recreate the resource.
    updatedAt string
    The timestamp when this image was last updated in RFC 3339.
    volumeIds string[]
    The volumes of the instance.
    created_at str
    The timestamp when this image was created in RFC 3339.
    disk_size int
    The disk size of the instance in GB.
    dns_name str
    The dns name of the instance.
    floating_ip_id str
    The floating IP attached to the instance.
    hostname str
    The hostname of your instance. If not provided will be initially set to the name attribute. - If the value of this attribute is configured and changes, Terraform will destroy and recreate the resource.
    image str
    The source image id, image slug or snapshot id of the instance. The image version can also specified together with the image slug in this format <image-slug>:<version>. Learn more about images here. - If the value of this attribute changes, Terraform will destroy and recreate the resource.
    image_id str
    The resulting image ID of the instance.
    metadata InstanceMetadataArgs
    Option to provide metadata. Currently supported is startup_script.
    name str
    The human-readable name for the instance.
    password str
    The password to access the instance. Your password must have upper and lower chars, digits and length between 8-72. Please Note: Only one of ssh_keys or password can be provided. Password is less secure - we recommend you use an SSH key-pair. - If the value of this attribute changes, Terraform will destroy and recreate the resource. - The string length must be at least 16.
    placement_option str
    The placement option identifier in which instances are physically located relative to each other within a zone. For example A or B. - If the value of this attribute changes, Terraform will destroy and recreate the resource.
    private_ip str
    The private IPv4 IP-Address (IPv4 address).
    public_ip str
    The public IPv4 IP-Address (IPv4 address).
    region str
    The region identifier. - If the value of this attribute changes, Terraform will destroy and recreate the resource. - The value must be one of: ["ARC-IS-HAF-1" "EUC-DE-MUC-1" "NORD-NO-KRS-1"].
    reservation_id str
    The id of the reservation the instance is associated with.
    security_group_ids Sequence[str]
    The security groups of the instance. If not provided will be set to the default security group.
    ssh_key_ids Sequence[str]
    The ssh keys of the instance. - If the value of this attribute changes, Terraform will destroy and recreate the resource.
    status str
    The instance status.
    timeouts InstanceTimeoutsArgs
    type str
    The instance type identifier. Learn more about instance types here. - If the value of this attribute changes, Terraform will destroy and recreate the resource.
    updated_at str
    The timestamp when this image was last updated in RFC 3339.
    volume_ids Sequence[str]
    The volumes of the instance.
    createdAt String
    The timestamp when this image was created in RFC 3339.
    diskSize Number
    The disk size of the instance in GB.
    dnsName String
    The dns name of the instance.
    floatingIpId String
    The floating IP attached to the instance.
    hostname String
    The hostname of your instance. If not provided will be initially set to the name attribute. - If the value of this attribute is configured and changes, Terraform will destroy and recreate the resource.
    image String
    The source image id, image slug or snapshot id of the instance. The image version can also specified together with the image slug in this format <image-slug>:<version>. Learn more about images here. - If the value of this attribute changes, Terraform will destroy and recreate the resource.
    imageId String
    The resulting image ID of the instance.
    metadata Property Map
    Option to provide metadata. Currently supported is startup_script.
    name String
    The human-readable name for the instance.
    password String
    The password to access the instance. Your password must have upper and lower chars, digits and length between 8-72. Please Note: Only one of ssh_keys or password can be provided. Password is less secure - we recommend you use an SSH key-pair. - If the value of this attribute changes, Terraform will destroy and recreate the resource. - The string length must be at least 16.
    placementOption String
    The placement option identifier in which instances are physically located relative to each other within a zone. For example A or B. - If the value of this attribute changes, Terraform will destroy and recreate the resource.
    privateIp String
    The private IPv4 IP-Address (IPv4 address).
    publicIp String
    The public IPv4 IP-Address (IPv4 address).
    region String
    The region identifier. - If the value of this attribute changes, Terraform will destroy and recreate the resource. - The value must be one of: ["ARC-IS-HAF-1" "EUC-DE-MUC-1" "NORD-NO-KRS-1"].
    reservationId String
    The id of the reservation the instance is associated with.
    securityGroupIds List<String>
    The security groups of the instance. If not provided will be set to the default security group.
    sshKeyIds List<String>
    The ssh keys of the instance. - If the value of this attribute changes, Terraform will destroy and recreate the resource.
    status String
    The instance status.
    timeouts Property Map
    type String
    The instance type identifier. Learn more about instance types here. - If the value of this attribute changes, Terraform will destroy and recreate the resource.
    updatedAt String
    The timestamp when this image was last updated in RFC 3339.
    volumeIds List<String>
    The volumes of the instance.

    Supporting Types

    InstanceMetadata, InstanceMetadataArgs

    InstanceTimeouts, InstanceTimeoutsArgs

    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    read String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    read str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    update str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    read String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

    Import

     $ pulumi import genesiscloud:index/instance:Instance example 18efeec8-94f0-4776-8ff2-5e9b49c74608

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    genesiscloud genesiscloud/pulumi-genesiscloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the genesiscloud Terraform Provider.
    genesiscloud logo
    Genesis Cloud v0.0.28 published on Tuesday, Sep 3, 2024 by Genesiscloud
    genesiscloud/pulumi-genesiscloud