1. Packages
  2. Civo
  3. API Docs
  4. Instance
Civo v2.3.19 published on Tuesday, Jul 16, 2024 by Pulumi

civo.Instance

Explore with Pulumi AI

civo logo
Civo v2.3.19 published on Tuesday, Jul 16, 2024 by Pulumi

    Provides a Civo instance resource. This can be used to create, modify, and delete instances.

    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,
                 firewall_id: Optional[str] = None,
                 region: Optional[str] = None,
                 reserved_ipv4: Optional[str] = None,
                 initial_user: Optional[str] = None,
                 network_id: Optional[str] = None,
                 notes: Optional[str] = None,
                 private_ipv4: Optional[str] = None,
                 hostname: Optional[str] = None,
                 disk_image: Optional[str] = None,
                 public_ip_required: Optional[str] = None,
                 reverse_dns: Optional[str] = None,
                 script: Optional[str] = None,
                 size: Optional[str] = None,
                 sshkey_id: Optional[str] = None,
                 tags: Optional[Sequence[str]] = None,
                 template: Optional[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: civo: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 Civo.Instance("instanceResource", new()
    {
        FirewallId = "string",
        Region = "string",
        ReservedIpv4 = "string",
        InitialUser = "string",
        NetworkId = "string",
        Notes = "string",
        PrivateIpv4 = "string",
        Hostname = "string",
        DiskImage = "string",
        PublicIpRequired = "string",
        ReverseDns = "string",
        Script = "string",
        Size = "string",
        SshkeyId = "string",
        Tags = new[]
        {
            "string",
        },
    });
    
    example, err := civo.NewInstance(ctx, "instanceResource", &civo.InstanceArgs{
    	FirewallId:       pulumi.String("string"),
    	Region:           pulumi.String("string"),
    	ReservedIpv4:     pulumi.String("string"),
    	InitialUser:      pulumi.String("string"),
    	NetworkId:        pulumi.String("string"),
    	Notes:            pulumi.String("string"),
    	PrivateIpv4:      pulumi.String("string"),
    	Hostname:         pulumi.String("string"),
    	DiskImage:        pulumi.String("string"),
    	PublicIpRequired: pulumi.String("string"),
    	ReverseDns:       pulumi.String("string"),
    	Script:           pulumi.String("string"),
    	Size:             pulumi.String("string"),
    	SshkeyId:         pulumi.String("string"),
    	Tags: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    var instanceResource = new Instance("instanceResource", InstanceArgs.builder()
        .firewallId("string")
        .region("string")
        .reservedIpv4("string")
        .initialUser("string")
        .networkId("string")
        .notes("string")
        .privateIpv4("string")
        .hostname("string")
        .diskImage("string")
        .publicIpRequired("string")
        .reverseDns("string")
        .script("string")
        .size("string")
        .sshkeyId("string")
        .tags("string")
        .build());
    
    instance_resource = civo.Instance("instanceResource",
        firewall_id="string",
        region="string",
        reserved_ipv4="string",
        initial_user="string",
        network_id="string",
        notes="string",
        private_ipv4="string",
        hostname="string",
        disk_image="string",
        public_ip_required="string",
        reverse_dns="string",
        script="string",
        size="string",
        sshkey_id="string",
        tags=["string"])
    
    const instanceResource = new civo.Instance("instanceResource", {
        firewallId: "string",
        region: "string",
        reservedIpv4: "string",
        initialUser: "string",
        networkId: "string",
        notes: "string",
        privateIpv4: "string",
        hostname: "string",
        diskImage: "string",
        publicIpRequired: "string",
        reverseDns: "string",
        script: "string",
        size: "string",
        sshkeyId: "string",
        tags: ["string"],
    });
    
    type: civo:Instance
    properties:
        diskImage: string
        firewallId: string
        hostname: string
        initialUser: string
        networkId: string
        notes: string
        privateIpv4: string
        publicIpRequired: string
        region: string
        reservedIpv4: string
        reverseDns: string
        script: string
        size: string
        sshkeyId: string
        tags:
            - 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:

    FirewallId string
    The ID of the firewall to use, from the current list. If left blank or not sent, the default firewall will be used (open to all)
    DiskImage string
    The ID for the disk image to use to build the instance
    Hostname string
    A fully qualified domain name that should be set as the instance's hostname
    InitialUser string
    The name of the initial user created on the server (optional; this will default to the template's default_username and fallback to civo)
    NetworkId string
    This must be the ID of the network from the network listing (optional; default network used when not specified)
    Notes string
    Add some notes to the instance
    PrivateIpv4 string
    The private IPv4 address for the instance (optional)
    PublicIpRequired string
    This should be either 'none' or 'create' (default: 'create')
    Region string
    The region for the instance, if not declare we use the region in declared in the provider
    ReservedIpv4 string
    Can be either the UUID, name, or the IP address of the reserved IP
    ReverseDns string
    A fully qualified domain name that should be used as the instance's IP's reverse DNS (optional, uses the hostname if unspecified)
    Script string
    The contents of a script that will be uploaded to /usr/local/bin/civo-user-init-script on your instance, read/write/executable only by root and then will be executed at the end of the cloud initialization
    Size string
    The name of the size, from the current list, e.g. g3.xsmall
    SshkeyId string
    The ID of an already uploaded SSH public key to use for login to the default user (optional; if one isn't provided a random password will be set and returned in the initial_password field)
    Tags List<string>
    An optional list of tags, represented as a key, value pair
    Template string
    The ID for the template to use to build the instance

    Deprecated: "template" attribute is deprecated. Moving forward, please use "disk_image" attribute.

    FirewallId string
    The ID of the firewall to use, from the current list. If left blank or not sent, the default firewall will be used (open to all)
    DiskImage string
    The ID for the disk image to use to build the instance
    Hostname string
    A fully qualified domain name that should be set as the instance's hostname
    InitialUser string
    The name of the initial user created on the server (optional; this will default to the template's default_username and fallback to civo)
    NetworkId string
    This must be the ID of the network from the network listing (optional; default network used when not specified)
    Notes string
    Add some notes to the instance
    PrivateIpv4 string
    The private IPv4 address for the instance (optional)
    PublicIpRequired string
    This should be either 'none' or 'create' (default: 'create')
    Region string
    The region for the instance, if not declare we use the region in declared in the provider
    ReservedIpv4 string
    Can be either the UUID, name, or the IP address of the reserved IP
    ReverseDns string
    A fully qualified domain name that should be used as the instance's IP's reverse DNS (optional, uses the hostname if unspecified)
    Script string
    The contents of a script that will be uploaded to /usr/local/bin/civo-user-init-script on your instance, read/write/executable only by root and then will be executed at the end of the cloud initialization
    Size string
    The name of the size, from the current list, e.g. g3.xsmall
    SshkeyId string
    The ID of an already uploaded SSH public key to use for login to the default user (optional; if one isn't provided a random password will be set and returned in the initial_password field)
    Tags []string
    An optional list of tags, represented as a key, value pair
    Template string
    The ID for the template to use to build the instance

    Deprecated: "template" attribute is deprecated. Moving forward, please use "disk_image" attribute.

    firewallId String
    The ID of the firewall to use, from the current list. If left blank or not sent, the default firewall will be used (open to all)
    diskImage String
    The ID for the disk image to use to build the instance
    hostname String
    A fully qualified domain name that should be set as the instance's hostname
    initialUser String
    The name of the initial user created on the server (optional; this will default to the template's default_username and fallback to civo)
    networkId String
    This must be the ID of the network from the network listing (optional; default network used when not specified)
    notes String
    Add some notes to the instance
    privateIpv4 String
    The private IPv4 address for the instance (optional)
    publicIpRequired String
    This should be either 'none' or 'create' (default: 'create')
    region String
    The region for the instance, if not declare we use the region in declared in the provider
    reservedIpv4 String
    Can be either the UUID, name, or the IP address of the reserved IP
    reverseDns String
    A fully qualified domain name that should be used as the instance's IP's reverse DNS (optional, uses the hostname if unspecified)
    script String
    The contents of a script that will be uploaded to /usr/local/bin/civo-user-init-script on your instance, read/write/executable only by root and then will be executed at the end of the cloud initialization
    size String
    The name of the size, from the current list, e.g. g3.xsmall
    sshkeyId String
    The ID of an already uploaded SSH public key to use for login to the default user (optional; if one isn't provided a random password will be set and returned in the initial_password field)
    tags List<String>
    An optional list of tags, represented as a key, value pair
    template String
    The ID for the template to use to build the instance

    Deprecated: "template" attribute is deprecated. Moving forward, please use "disk_image" attribute.

    firewallId string
    The ID of the firewall to use, from the current list. If left blank or not sent, the default firewall will be used (open to all)
    diskImage string
    The ID for the disk image to use to build the instance
    hostname string
    A fully qualified domain name that should be set as the instance's hostname
    initialUser string
    The name of the initial user created on the server (optional; this will default to the template's default_username and fallback to civo)
    networkId string
    This must be the ID of the network from the network listing (optional; default network used when not specified)
    notes string
    Add some notes to the instance
    privateIpv4 string
    The private IPv4 address for the instance (optional)
    publicIpRequired string
    This should be either 'none' or 'create' (default: 'create')
    region string
    The region for the instance, if not declare we use the region in declared in the provider
    reservedIpv4 string
    Can be either the UUID, name, or the IP address of the reserved IP
    reverseDns string
    A fully qualified domain name that should be used as the instance's IP's reverse DNS (optional, uses the hostname if unspecified)
    script string
    The contents of a script that will be uploaded to /usr/local/bin/civo-user-init-script on your instance, read/write/executable only by root and then will be executed at the end of the cloud initialization
    size string
    The name of the size, from the current list, e.g. g3.xsmall
    sshkeyId string
    The ID of an already uploaded SSH public key to use for login to the default user (optional; if one isn't provided a random password will be set and returned in the initial_password field)
    tags string[]
    An optional list of tags, represented as a key, value pair
    template string
    The ID for the template to use to build the instance

    Deprecated: "template" attribute is deprecated. Moving forward, please use "disk_image" attribute.

    firewall_id str
    The ID of the firewall to use, from the current list. If left blank or not sent, the default firewall will be used (open to all)
    disk_image str
    The ID for the disk image to use to build the instance
    hostname str
    A fully qualified domain name that should be set as the instance's hostname
    initial_user str
    The name of the initial user created on the server (optional; this will default to the template's default_username and fallback to civo)
    network_id str
    This must be the ID of the network from the network listing (optional; default network used when not specified)
    notes str
    Add some notes to the instance
    private_ipv4 str
    The private IPv4 address for the instance (optional)
    public_ip_required str
    This should be either 'none' or 'create' (default: 'create')
    region str
    The region for the instance, if not declare we use the region in declared in the provider
    reserved_ipv4 str
    Can be either the UUID, name, or the IP address of the reserved IP
    reverse_dns str
    A fully qualified domain name that should be used as the instance's IP's reverse DNS (optional, uses the hostname if unspecified)
    script str
    The contents of a script that will be uploaded to /usr/local/bin/civo-user-init-script on your instance, read/write/executable only by root and then will be executed at the end of the cloud initialization
    size str
    The name of the size, from the current list, e.g. g3.xsmall
    sshkey_id str
    The ID of an already uploaded SSH public key to use for login to the default user (optional; if one isn't provided a random password will be set and returned in the initial_password field)
    tags Sequence[str]
    An optional list of tags, represented as a key, value pair
    template str
    The ID for the template to use to build the instance

    Deprecated: "template" attribute is deprecated. Moving forward, please use "disk_image" attribute.

    firewallId String
    The ID of the firewall to use, from the current list. If left blank or not sent, the default firewall will be used (open to all)
    diskImage String
    The ID for the disk image to use to build the instance
    hostname String
    A fully qualified domain name that should be set as the instance's hostname
    initialUser String
    The name of the initial user created on the server (optional; this will default to the template's default_username and fallback to civo)
    networkId String
    This must be the ID of the network from the network listing (optional; default network used when not specified)
    notes String
    Add some notes to the instance
    privateIpv4 String
    The private IPv4 address for the instance (optional)
    publicIpRequired String
    This should be either 'none' or 'create' (default: 'create')
    region String
    The region for the instance, if not declare we use the region in declared in the provider
    reservedIpv4 String
    Can be either the UUID, name, or the IP address of the reserved IP
    reverseDns String
    A fully qualified domain name that should be used as the instance's IP's reverse DNS (optional, uses the hostname if unspecified)
    script String
    The contents of a script that will be uploaded to /usr/local/bin/civo-user-init-script on your instance, read/write/executable only by root and then will be executed at the end of the cloud initialization
    size String
    The name of the size, from the current list, e.g. g3.xsmall
    sshkeyId String
    The ID of an already uploaded SSH public key to use for login to the default user (optional; if one isn't provided a random password will be set and returned in the initial_password field)
    tags List<String>
    An optional list of tags, represented as a key, value pair
    template String
    The ID for the template to use to build the instance

    Deprecated: "template" attribute is deprecated. Moving forward, please use "disk_image" attribute.

    Outputs

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

    CpuCores int
    Instance's CPU cores
    CreatedAt string
    Timestamp when the instance was created
    DiskGb int
    Instance's disk (GB)
    Id string
    The provider-assigned unique ID for this managed resource.
    InitialPassword string
    Initial password for login
    PrivateIp string
    Instance's private IP address
    PublicIp string
    Instance's public IP address
    RamMb int
    Instance's RAM (MB)
    SourceId string
    Instance's source ID
    SourceType string
    Instance's source type
    Status string
    Instance's status
    CpuCores int
    Instance's CPU cores
    CreatedAt string
    Timestamp when the instance was created
    DiskGb int
    Instance's disk (GB)
    Id string
    The provider-assigned unique ID for this managed resource.
    InitialPassword string
    Initial password for login
    PrivateIp string
    Instance's private IP address
    PublicIp string
    Instance's public IP address
    RamMb int
    Instance's RAM (MB)
    SourceId string
    Instance's source ID
    SourceType string
    Instance's source type
    Status string
    Instance's status
    cpuCores Integer
    Instance's CPU cores
    createdAt String
    Timestamp when the instance was created
    diskGb Integer
    Instance's disk (GB)
    id String
    The provider-assigned unique ID for this managed resource.
    initialPassword String
    Initial password for login
    privateIp String
    Instance's private IP address
    publicIp String
    Instance's public IP address
    ramMb Integer
    Instance's RAM (MB)
    sourceId String
    Instance's source ID
    sourceType String
    Instance's source type
    status String
    Instance's status
    cpuCores number
    Instance's CPU cores
    createdAt string
    Timestamp when the instance was created
    diskGb number
    Instance's disk (GB)
    id string
    The provider-assigned unique ID for this managed resource.
    initialPassword string
    Initial password for login
    privateIp string
    Instance's private IP address
    publicIp string
    Instance's public IP address
    ramMb number
    Instance's RAM (MB)
    sourceId string
    Instance's source ID
    sourceType string
    Instance's source type
    status string
    Instance's status
    cpu_cores int
    Instance's CPU cores
    created_at str
    Timestamp when the instance was created
    disk_gb int
    Instance's disk (GB)
    id str
    The provider-assigned unique ID for this managed resource.
    initial_password str
    Initial password for login
    private_ip str
    Instance's private IP address
    public_ip str
    Instance's public IP address
    ram_mb int
    Instance's RAM (MB)
    source_id str
    Instance's source ID
    source_type str
    Instance's source type
    status str
    Instance's status
    cpuCores Number
    Instance's CPU cores
    createdAt String
    Timestamp when the instance was created
    diskGb Number
    Instance's disk (GB)
    id String
    The provider-assigned unique ID for this managed resource.
    initialPassword String
    Initial password for login
    privateIp String
    Instance's private IP address
    publicIp String
    Instance's public IP address
    ramMb Number
    Instance's RAM (MB)
    sourceId String
    Instance's source ID
    sourceType String
    Instance's source type
    status String
    Instance's status

    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,
            cpu_cores: Optional[int] = None,
            created_at: Optional[str] = None,
            disk_gb: Optional[int] = None,
            disk_image: Optional[str] = None,
            firewall_id: Optional[str] = None,
            hostname: Optional[str] = None,
            initial_password: Optional[str] = None,
            initial_user: Optional[str] = None,
            network_id: Optional[str] = None,
            notes: Optional[str] = None,
            private_ip: Optional[str] = None,
            private_ipv4: Optional[str] = None,
            public_ip: Optional[str] = None,
            public_ip_required: Optional[str] = None,
            ram_mb: Optional[int] = None,
            region: Optional[str] = None,
            reserved_ipv4: Optional[str] = None,
            reverse_dns: Optional[str] = None,
            script: Optional[str] = None,
            size: Optional[str] = None,
            source_id: Optional[str] = None,
            source_type: Optional[str] = None,
            sshkey_id: Optional[str] = None,
            status: Optional[str] = None,
            tags: Optional[Sequence[str]] = None,
            template: Optional[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:
    CpuCores int
    Instance's CPU cores
    CreatedAt string
    Timestamp when the instance was created
    DiskGb int
    Instance's disk (GB)
    DiskImage string
    The ID for the disk image to use to build the instance
    FirewallId string
    The ID of the firewall to use, from the current list. If left blank or not sent, the default firewall will be used (open to all)
    Hostname string
    A fully qualified domain name that should be set as the instance's hostname
    InitialPassword string
    Initial password for login
    InitialUser string
    The name of the initial user created on the server (optional; this will default to the template's default_username and fallback to civo)
    NetworkId string
    This must be the ID of the network from the network listing (optional; default network used when not specified)
    Notes string
    Add some notes to the instance
    PrivateIp string
    Instance's private IP address
    PrivateIpv4 string
    The private IPv4 address for the instance (optional)
    PublicIp string
    Instance's public IP address
    PublicIpRequired string
    This should be either 'none' or 'create' (default: 'create')
    RamMb int
    Instance's RAM (MB)
    Region string
    The region for the instance, if not declare we use the region in declared in the provider
    ReservedIpv4 string
    Can be either the UUID, name, or the IP address of the reserved IP
    ReverseDns string
    A fully qualified domain name that should be used as the instance's IP's reverse DNS (optional, uses the hostname if unspecified)
    Script string
    The contents of a script that will be uploaded to /usr/local/bin/civo-user-init-script on your instance, read/write/executable only by root and then will be executed at the end of the cloud initialization
    Size string
    The name of the size, from the current list, e.g. g3.xsmall
    SourceId string
    Instance's source ID
    SourceType string
    Instance's source type
    SshkeyId string
    The ID of an already uploaded SSH public key to use for login to the default user (optional; if one isn't provided a random password will be set and returned in the initial_password field)
    Status string
    Instance's status
    Tags List<string>
    An optional list of tags, represented as a key, value pair
    Template string
    The ID for the template to use to build the instance

    Deprecated: "template" attribute is deprecated. Moving forward, please use "disk_image" attribute.

    CpuCores int
    Instance's CPU cores
    CreatedAt string
    Timestamp when the instance was created
    DiskGb int
    Instance's disk (GB)
    DiskImage string
    The ID for the disk image to use to build the instance
    FirewallId string
    The ID of the firewall to use, from the current list. If left blank or not sent, the default firewall will be used (open to all)
    Hostname string
    A fully qualified domain name that should be set as the instance's hostname
    InitialPassword string
    Initial password for login
    InitialUser string
    The name of the initial user created on the server (optional; this will default to the template's default_username and fallback to civo)
    NetworkId string
    This must be the ID of the network from the network listing (optional; default network used when not specified)
    Notes string
    Add some notes to the instance
    PrivateIp string
    Instance's private IP address
    PrivateIpv4 string
    The private IPv4 address for the instance (optional)
    PublicIp string
    Instance's public IP address
    PublicIpRequired string
    This should be either 'none' or 'create' (default: 'create')
    RamMb int
    Instance's RAM (MB)
    Region string
    The region for the instance, if not declare we use the region in declared in the provider
    ReservedIpv4 string
    Can be either the UUID, name, or the IP address of the reserved IP
    ReverseDns string
    A fully qualified domain name that should be used as the instance's IP's reverse DNS (optional, uses the hostname if unspecified)
    Script string
    The contents of a script that will be uploaded to /usr/local/bin/civo-user-init-script on your instance, read/write/executable only by root and then will be executed at the end of the cloud initialization
    Size string
    The name of the size, from the current list, e.g. g3.xsmall
    SourceId string
    Instance's source ID
    SourceType string
    Instance's source type
    SshkeyId string
    The ID of an already uploaded SSH public key to use for login to the default user (optional; if one isn't provided a random password will be set and returned in the initial_password field)
    Status string
    Instance's status
    Tags []string
    An optional list of tags, represented as a key, value pair
    Template string
    The ID for the template to use to build the instance

    Deprecated: "template" attribute is deprecated. Moving forward, please use "disk_image" attribute.

    cpuCores Integer
    Instance's CPU cores
    createdAt String
    Timestamp when the instance was created
    diskGb Integer
    Instance's disk (GB)
    diskImage String
    The ID for the disk image to use to build the instance
    firewallId String
    The ID of the firewall to use, from the current list. If left blank or not sent, the default firewall will be used (open to all)
    hostname String
    A fully qualified domain name that should be set as the instance's hostname
    initialPassword String
    Initial password for login
    initialUser String
    The name of the initial user created on the server (optional; this will default to the template's default_username and fallback to civo)
    networkId String
    This must be the ID of the network from the network listing (optional; default network used when not specified)
    notes String
    Add some notes to the instance
    privateIp String
    Instance's private IP address
    privateIpv4 String
    The private IPv4 address for the instance (optional)
    publicIp String
    Instance's public IP address
    publicIpRequired String
    This should be either 'none' or 'create' (default: 'create')
    ramMb Integer
    Instance's RAM (MB)
    region String
    The region for the instance, if not declare we use the region in declared in the provider
    reservedIpv4 String
    Can be either the UUID, name, or the IP address of the reserved IP
    reverseDns String
    A fully qualified domain name that should be used as the instance's IP's reverse DNS (optional, uses the hostname if unspecified)
    script String
    The contents of a script that will be uploaded to /usr/local/bin/civo-user-init-script on your instance, read/write/executable only by root and then will be executed at the end of the cloud initialization
    size String
    The name of the size, from the current list, e.g. g3.xsmall
    sourceId String
    Instance's source ID
    sourceType String
    Instance's source type
    sshkeyId String
    The ID of an already uploaded SSH public key to use for login to the default user (optional; if one isn't provided a random password will be set and returned in the initial_password field)
    status String
    Instance's status
    tags List<String>
    An optional list of tags, represented as a key, value pair
    template String
    The ID for the template to use to build the instance

    Deprecated: "template" attribute is deprecated. Moving forward, please use "disk_image" attribute.

    cpuCores number
    Instance's CPU cores
    createdAt string
    Timestamp when the instance was created
    diskGb number
    Instance's disk (GB)
    diskImage string
    The ID for the disk image to use to build the instance
    firewallId string
    The ID of the firewall to use, from the current list. If left blank or not sent, the default firewall will be used (open to all)
    hostname string
    A fully qualified domain name that should be set as the instance's hostname
    initialPassword string
    Initial password for login
    initialUser string
    The name of the initial user created on the server (optional; this will default to the template's default_username and fallback to civo)
    networkId string
    This must be the ID of the network from the network listing (optional; default network used when not specified)
    notes string
    Add some notes to the instance
    privateIp string
    Instance's private IP address
    privateIpv4 string
    The private IPv4 address for the instance (optional)
    publicIp string
    Instance's public IP address
    publicIpRequired string
    This should be either 'none' or 'create' (default: 'create')
    ramMb number
    Instance's RAM (MB)
    region string
    The region for the instance, if not declare we use the region in declared in the provider
    reservedIpv4 string
    Can be either the UUID, name, or the IP address of the reserved IP
    reverseDns string
    A fully qualified domain name that should be used as the instance's IP's reverse DNS (optional, uses the hostname if unspecified)
    script string
    The contents of a script that will be uploaded to /usr/local/bin/civo-user-init-script on your instance, read/write/executable only by root and then will be executed at the end of the cloud initialization
    size string
    The name of the size, from the current list, e.g. g3.xsmall
    sourceId string
    Instance's source ID
    sourceType string
    Instance's source type
    sshkeyId string
    The ID of an already uploaded SSH public key to use for login to the default user (optional; if one isn't provided a random password will be set and returned in the initial_password field)
    status string
    Instance's status
    tags string[]
    An optional list of tags, represented as a key, value pair
    template string
    The ID for the template to use to build the instance

    Deprecated: "template" attribute is deprecated. Moving forward, please use "disk_image" attribute.

    cpu_cores int
    Instance's CPU cores
    created_at str
    Timestamp when the instance was created
    disk_gb int
    Instance's disk (GB)
    disk_image str
    The ID for the disk image to use to build the instance
    firewall_id str
    The ID of the firewall to use, from the current list. If left blank or not sent, the default firewall will be used (open to all)
    hostname str
    A fully qualified domain name that should be set as the instance's hostname
    initial_password str
    Initial password for login
    initial_user str
    The name of the initial user created on the server (optional; this will default to the template's default_username and fallback to civo)
    network_id str
    This must be the ID of the network from the network listing (optional; default network used when not specified)
    notes str
    Add some notes to the instance
    private_ip str
    Instance's private IP address
    private_ipv4 str
    The private IPv4 address for the instance (optional)
    public_ip str
    Instance's public IP address
    public_ip_required str
    This should be either 'none' or 'create' (default: 'create')
    ram_mb int
    Instance's RAM (MB)
    region str
    The region for the instance, if not declare we use the region in declared in the provider
    reserved_ipv4 str
    Can be either the UUID, name, or the IP address of the reserved IP
    reverse_dns str
    A fully qualified domain name that should be used as the instance's IP's reverse DNS (optional, uses the hostname if unspecified)
    script str
    The contents of a script that will be uploaded to /usr/local/bin/civo-user-init-script on your instance, read/write/executable only by root and then will be executed at the end of the cloud initialization
    size str
    The name of the size, from the current list, e.g. g3.xsmall
    source_id str
    Instance's source ID
    source_type str
    Instance's source type
    sshkey_id str
    The ID of an already uploaded SSH public key to use for login to the default user (optional; if one isn't provided a random password will be set and returned in the initial_password field)
    status str
    Instance's status
    tags Sequence[str]
    An optional list of tags, represented as a key, value pair
    template str
    The ID for the template to use to build the instance

    Deprecated: "template" attribute is deprecated. Moving forward, please use "disk_image" attribute.

    cpuCores Number
    Instance's CPU cores
    createdAt String
    Timestamp when the instance was created
    diskGb Number
    Instance's disk (GB)
    diskImage String
    The ID for the disk image to use to build the instance
    firewallId String
    The ID of the firewall to use, from the current list. If left blank or not sent, the default firewall will be used (open to all)
    hostname String
    A fully qualified domain name that should be set as the instance's hostname
    initialPassword String
    Initial password for login
    initialUser String
    The name of the initial user created on the server (optional; this will default to the template's default_username and fallback to civo)
    networkId String
    This must be the ID of the network from the network listing (optional; default network used when not specified)
    notes String
    Add some notes to the instance
    privateIp String
    Instance's private IP address
    privateIpv4 String
    The private IPv4 address for the instance (optional)
    publicIp String
    Instance's public IP address
    publicIpRequired String
    This should be either 'none' or 'create' (default: 'create')
    ramMb Number
    Instance's RAM (MB)
    region String
    The region for the instance, if not declare we use the region in declared in the provider
    reservedIpv4 String
    Can be either the UUID, name, or the IP address of the reserved IP
    reverseDns String
    A fully qualified domain name that should be used as the instance's IP's reverse DNS (optional, uses the hostname if unspecified)
    script String
    The contents of a script that will be uploaded to /usr/local/bin/civo-user-init-script on your instance, read/write/executable only by root and then will be executed at the end of the cloud initialization
    size String
    The name of the size, from the current list, e.g. g3.xsmall
    sourceId String
    Instance's source ID
    sourceType String
    Instance's source type
    sshkeyId String
    The ID of an already uploaded SSH public key to use for login to the default user (optional; if one isn't provided a random password will be set and returned in the initial_password field)
    status String
    Instance's status
    tags List<String>
    An optional list of tags, represented as a key, value pair
    template String
    The ID for the template to use to build the instance

    Deprecated: "template" attribute is deprecated. Moving forward, please use "disk_image" attribute.

    Import

    using ID

    $ pulumi import civo:index/instance:Instance myintance 18bd98ad-1b6e-4f87-b48f-e690b4fd7413
    

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

    Package Details

    Repository
    Civo pulumi/pulumi-civo
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the civo Terraform Provider.
    civo logo
    Civo v2.3.19 published on Tuesday, Jul 16, 2024 by Pulumi