Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Gcore Provider
  3. API Docs
  4. GpuVirtualImage
gcore 0.22.0 published on Wednesday, Apr 30, 2025 by g-core
g-core/terraform-provider-gcore

gcore.GpuVirtualImage

Explore with Pulumi AI

gcore logo
gcore 0.22.0 published on Wednesday, Apr 30, 2025 by g-core
g-core/terraform-provider-gcore

    Manages a virtual GPU image

    Create GpuVirtualImage Resource

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

    Constructor syntax

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

@overload
def GpuVirtualImage(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    url: Optional[str] = None,
                    os_distro: Optional[str] = None,
                    os_version: Optional[str] = None,
                    hw_firmware_type: Optional[str] = None,
                    metadata: Optional[Mapping[str, str]] = None,
                    name: Optional[str] = None,
                    architecture: Optional[str] = None,
                    os_type: Optional[str] = None,
                    gpu_virtual_image_id: Optional[str] = None,
                    project_id: Optional[float] = None,
                    project_name: Optional[str] = None,
                    region_id: Optional[float] = None,
                    region_name: Optional[str] = None,
                    ssh_key: Optional[str] = None,
                    cow_format: Optional[bool] = None)
    func NewGpuVirtualImage(ctx *Context, name string, args GpuVirtualImageArgs, opts ...ResourceOption) (*GpuVirtualImage, error)
    public GpuVirtualImage(string name, GpuVirtualImageArgs args, CustomResourceOptions? opts = null)
    public GpuVirtualImage(String name, GpuVirtualImageArgs args)
public GpuVirtualImage(String name, GpuVirtualImageArgs args, CustomResourceOptions options)

    type: gcore:GpuVirtualImage
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 GpuVirtualImageArgs
    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 GpuVirtualImageArgs
    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 GpuVirtualImageArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GpuVirtualImageArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GpuVirtualImageArgs
    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 gpuVirtualImageResource = new Gcore.GpuVirtualImage("gpuVirtualImageResource", new()
{
    Url = "string",
    OsDistro = "string",
    OsVersion = "string",
    HwFirmwareType = "string",
    Metadata = 
    {
        { "string", "string" },
    },
    Name = "string",
    Architecture = "string",
    OsType = "string",
    GpuVirtualImageId = "string",
    ProjectId = 0,
    ProjectName = "string",
    RegionId = 0,
    RegionName = "string",
    SshKey = "string",
    CowFormat = false,
});

    example, err := gcore.NewGpuVirtualImage(ctx, "gpuVirtualImageResource", &gcore.GpuVirtualImageArgs{
	Url:            pulumi.String("string"),
	OsDistro:       pulumi.String("string"),
	OsVersion:      pulumi.String("string"),
	HwFirmwareType: pulumi.String("string"),
	Metadata: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name:              pulumi.String("string"),
	Architecture:      pulumi.String("string"),
	OsType:            pulumi.String("string"),
	GpuVirtualImageId: pulumi.String("string"),
	ProjectId:         pulumi.Float64(0),
	ProjectName:       pulumi.String("string"),
	RegionId:          pulumi.Float64(0),
	RegionName:        pulumi.String("string"),
	SshKey:            pulumi.String("string"),
	CowFormat:         pulumi.Bool(false),
})

    var gpuVirtualImageResource = new GpuVirtualImage("gpuVirtualImageResource", GpuVirtualImageArgs.builder()
    .url("string")
    .osDistro("string")
    .osVersion("string")
    .hwFirmwareType("string")
    .metadata(Map.of("string", "string"))
    .name("string")
    .architecture("string")
    .osType("string")
    .gpuVirtualImageId("string")
    .projectId(0)
    .projectName("string")
    .regionId(0)
    .regionName("string")
    .sshKey("string")
    .cowFormat(false)
    .build());

    gpu_virtual_image_resource = gcore.GpuVirtualImage("gpuVirtualImageResource",
    url="string",
    os_distro="string",
    os_version="string",
    hw_firmware_type="string",
    metadata={
        "string": "string",
    },
    name="string",
    architecture="string",
    os_type="string",
    gpu_virtual_image_id="string",
    project_id=0,
    project_name="string",
    region_id=0,
    region_name="string",
    ssh_key="string",
    cow_format=False)

    const gpuVirtualImageResource = new gcore.GpuVirtualImage("gpuVirtualImageResource", {
    url: "string",
    osDistro: "string",
    osVersion: "string",
    hwFirmwareType: "string",
    metadata: {
        string: "string",
    },
    name: "string",
    architecture: "string",
    osType: "string",
    gpuVirtualImageId: "string",
    projectId: 0,
    projectName: "string",
    regionId: 0,
    regionName: "string",
    sshKey: "string",
    cowFormat: false,
});

    type: gcore:GpuVirtualImage
properties:
    architecture: string
    cowFormat: false
    gpuVirtualImageId: string
    hwFirmwareType: string
    metadata:
        string: string
    name: string
    osDistro: string
    osType: string
    osVersion: string
    projectId: 0
    projectName: string
    regionId: 0
    regionName: string
    sshKey: string
    url: string

    GpuVirtualImage Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The GpuVirtualImage resource accepts the following input properties:

    Url string
    Image URL
    Architecture string
    Image architecture type: aarch64, x86_64
    CowFormat bool
    When True, image cannot be deleted unless all volumes, created from it, are deleted
    GpuVirtualImageId string
    The ID of this resource.
    HwFirmwareType string
    Specifies the type of firmware with which to boot the guest
    Metadata Dictionary<string, string>
    Create one or more metadata items for a cluster
    Name string
    Image name
    OsDistro string
    OS Distribution, i.e. Debian, CentOS, Ubuntu, CoreOS etc
    OsType string
    The operating system installed on the image
    OsVersion string
    OS version, i.e. 19.04 (for Ubuntu) or 9.4 for Debian
    ProjectId double
    Project ID
    ProjectName string
    Project name
    RegionId double
    Region ID
    RegionName string
    Region name
    SshKey string
    Permission to use a ssh key in instances
    Url string
    Image URL
    Architecture string
    Image architecture type: aarch64, x86_64
    CowFormat bool
    When True, image cannot be deleted unless all volumes, created from it, are deleted
    GpuVirtualImageId string
    The ID of this resource.
    HwFirmwareType string
    Specifies the type of firmware with which to boot the guest
    Metadata map[string]string
    Create one or more metadata items for a cluster
    Name string
    Image name
    OsDistro string
    OS Distribution, i.e. Debian, CentOS, Ubuntu, CoreOS etc
    OsType string
    The operating system installed on the image
    OsVersion string
    OS version, i.e. 19.04 (for Ubuntu) or 9.4 for Debian
    ProjectId float64
    Project ID
    ProjectName string
    Project name
    RegionId float64
    Region ID
    RegionName string
    Region name
    SshKey string
    Permission to use a ssh key in instances
    url String
    Image URL
    architecture String
    Image architecture type: aarch64, x86_64
    cowFormat Boolean
    When True, image cannot be deleted unless all volumes, created from it, are deleted
    gpuVirtualImageId String
    The ID of this resource.
    hwFirmwareType String
    Specifies the type of firmware with which to boot the guest
    metadata Map<String,String>
    Create one or more metadata items for a cluster
    name String
    Image name
    osDistro String
    OS Distribution, i.e. Debian, CentOS, Ubuntu, CoreOS etc
    osType String
    The operating system installed on the image
    osVersion String
    OS version, i.e. 19.04 (for Ubuntu) or 9.4 for Debian
    projectId Double
    Project ID
    projectName String
    Project name
    regionId Double
    Region ID
    regionName String
    Region name
    sshKey String
    Permission to use a ssh key in instances
    url string
    Image URL
    architecture string
    Image architecture type: aarch64, x86_64
    cowFormat boolean
    When True, image cannot be deleted unless all volumes, created from it, are deleted
    gpuVirtualImageId string
    The ID of this resource.
    hwFirmwareType string
    Specifies the type of firmware with which to boot the guest
    metadata {[key: string]: string}
    Create one or more metadata items for a cluster
    name string
    Image name
    osDistro string
    OS Distribution, i.e. Debian, CentOS, Ubuntu, CoreOS etc
    osType string
    The operating system installed on the image
    osVersion string
    OS version, i.e. 19.04 (for Ubuntu) or 9.4 for Debian
    projectId number
    Project ID
    projectName string
    Project name
    regionId number
    Region ID
    regionName string
    Region name
    sshKey string
    Permission to use a ssh key in instances
    url str
    Image URL
    architecture str
    Image architecture type: aarch64, x86_64
    cow_format bool
    When True, image cannot be deleted unless all volumes, created from it, are deleted
    gpu_virtual_image_id str
    The ID of this resource.
    hw_firmware_type str
    Specifies the type of firmware with which to boot the guest
    metadata Mapping[str, str]
    Create one or more metadata items for a cluster
    name str
    Image name
    os_distro str
    OS Distribution, i.e. Debian, CentOS, Ubuntu, CoreOS etc
    os_type str
    The operating system installed on the image
    os_version str
    OS version, i.e. 19.04 (for Ubuntu) or 9.4 for Debian
    project_id float
    Project ID
    project_name str
    Project name
    region_id float
    Region ID
    region_name str
    Region name
    ssh_key str
    Permission to use a ssh key in instances
    url String
    Image URL
    architecture String
    Image architecture type: aarch64, x86_64
    cowFormat Boolean
    When True, image cannot be deleted unless all volumes, created from it, are deleted
    gpuVirtualImageId String
    The ID of this resource.
    hwFirmwareType String
    Specifies the type of firmware with which to boot the guest
    metadata Map<String>
    Create one or more metadata items for a cluster
    name String
    Image name
    osDistro String
    OS Distribution, i.e. Debian, CentOS, Ubuntu, CoreOS etc
    osType String
    The operating system installed on the image
    osVersion String
    OS version, i.e. 19.04 (for Ubuntu) or 9.4 for Debian
    projectId Number
    Project ID
    projectName String
    Project name
    regionId Number
    Region ID
    regionName String
    Region name
    sshKey String
    Permission to use a ssh key in instances

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing GpuVirtualImage Resource

    Get an existing GpuVirtualImage 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?: GpuVirtualImageState, opts?: CustomResourceOptions): GpuVirtualImage
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        architecture: Optional[str] = None,
        cow_format: Optional[bool] = None,
        gpu_virtual_image_id: Optional[str] = None,
        hw_firmware_type: Optional[str] = None,
        metadata: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        os_distro: Optional[str] = None,
        os_type: Optional[str] = None,
        os_version: Optional[str] = None,
        project_id: Optional[float] = None,
        project_name: Optional[str] = None,
        region_id: Optional[float] = None,
        region_name: Optional[str] = None,
        ssh_key: Optional[str] = None,
        url: Optional[str] = None) -> GpuVirtualImage
    func GetGpuVirtualImage(ctx *Context, name string, id IDInput, state *GpuVirtualImageState, opts ...ResourceOption) (*GpuVirtualImage, error)
    public static GpuVirtualImage Get(string name, Input<string> id, GpuVirtualImageState? state, CustomResourceOptions? opts = null)
    public static GpuVirtualImage get(String name, Output<String> id, GpuVirtualImageState state, CustomResourceOptions options)
    resources:  _:    type: gcore:GpuVirtualImage    get:      id: ${id}
    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:
    Architecture string
    Image architecture type: aarch64, x86_64
    CowFormat bool
    When True, image cannot be deleted unless all volumes, created from it, are deleted
    GpuVirtualImageId string
    The ID of this resource.
    HwFirmwareType string
    Specifies the type of firmware with which to boot the guest
    Metadata Dictionary<string, string>
    Create one or more metadata items for a cluster
    Name string
    Image name
    OsDistro string
    OS Distribution, i.e. Debian, CentOS, Ubuntu, CoreOS etc
    OsType string
    The operating system installed on the image
    OsVersion string
    OS version, i.e. 19.04 (for Ubuntu) or 9.4 for Debian
    ProjectId double
    Project ID
    ProjectName string
    Project name
    RegionId double
    Region ID
    RegionName string
    Region name
    SshKey string
    Permission to use a ssh key in instances
    Url string
    Image URL
    Architecture string
    Image architecture type: aarch64, x86_64
    CowFormat bool
    When True, image cannot be deleted unless all volumes, created from it, are deleted
    GpuVirtualImageId string
    The ID of this resource.
    HwFirmwareType string
    Specifies the type of firmware with which to boot the guest
    Metadata map[string]string
    Create one or more metadata items for a cluster
    Name string
    Image name
    OsDistro string
    OS Distribution, i.e. Debian, CentOS, Ubuntu, CoreOS etc
    OsType string
    The operating system installed on the image
    OsVersion string
    OS version, i.e. 19.04 (for Ubuntu) or 9.4 for Debian
    ProjectId float64
    Project ID
    ProjectName string
    Project name
    RegionId float64
    Region ID
    RegionName string
    Region name
    SshKey string
    Permission to use a ssh key in instances
    Url string
    Image URL
    architecture String
    Image architecture type: aarch64, x86_64
    cowFormat Boolean
    When True, image cannot be deleted unless all volumes, created from it, are deleted
    gpuVirtualImageId String
    The ID of this resource.
    hwFirmwareType String
    Specifies the type of firmware with which to boot the guest
    metadata Map<String,String>
    Create one or more metadata items for a cluster
    name String
    Image name
    osDistro String
    OS Distribution, i.e. Debian, CentOS, Ubuntu, CoreOS etc
    osType String
    The operating system installed on the image
    osVersion String
    OS version, i.e. 19.04 (for Ubuntu) or 9.4 for Debian
    projectId Double
    Project ID
    projectName String
    Project name
    regionId Double
    Region ID
    regionName String
    Region name
    sshKey String
    Permission to use a ssh key in instances
    url String
    Image URL
    architecture string
    Image architecture type: aarch64, x86_64
    cowFormat boolean
    When True, image cannot be deleted unless all volumes, created from it, are deleted
    gpuVirtualImageId string
    The ID of this resource.
    hwFirmwareType string
    Specifies the type of firmware with which to boot the guest
    metadata {[key: string]: string}
    Create one or more metadata items for a cluster
    name string
    Image name
    osDistro string
    OS Distribution, i.e. Debian, CentOS, Ubuntu, CoreOS etc
    osType string
    The operating system installed on the image
    osVersion string
    OS version, i.e. 19.04 (for Ubuntu) or 9.4 for Debian
    projectId number
    Project ID
    projectName string
    Project name
    regionId number
    Region ID
    regionName string
    Region name
    sshKey string
    Permission to use a ssh key in instances
    url string
    Image URL
    architecture str
    Image architecture type: aarch64, x86_64
    cow_format bool
    When True, image cannot be deleted unless all volumes, created from it, are deleted
    gpu_virtual_image_id str
    The ID of this resource.
    hw_firmware_type str
    Specifies the type of firmware with which to boot the guest
    metadata Mapping[str, str]
    Create one or more metadata items for a cluster
    name str
    Image name
    os_distro str
    OS Distribution, i.e. Debian, CentOS, Ubuntu, CoreOS etc
    os_type str
    The operating system installed on the image
    os_version str
    OS version, i.e. 19.04 (for Ubuntu) or 9.4 for Debian
    project_id float
    Project ID
    project_name str
    Project name
    region_id float
    Region ID
    region_name str
    Region name
    ssh_key str
    Permission to use a ssh key in instances
    url str
    Image URL
    architecture String
    Image architecture type: aarch64, x86_64
    cowFormat Boolean
    When True, image cannot be deleted unless all volumes, created from it, are deleted
    gpuVirtualImageId String
    The ID of this resource.
    hwFirmwareType String
    Specifies the type of firmware with which to boot the guest
    metadata Map<String>
    Create one or more metadata items for a cluster
    name String
    Image name
    osDistro String
    OS Distribution, i.e. Debian, CentOS, Ubuntu, CoreOS etc
    osType String
    The operating system installed on the image
    osVersion String
    OS version, i.e. 19.04 (for Ubuntu) or 9.4 for Debian
    projectId Number
    Project ID
    projectName String
    Project name
    regionId Number
    Region ID
    regionName String
    Region name
    sshKey String
    Permission to use a ssh key in instances
    url String
    Image URL

    Package Details

    Repository
    gcore g-core/terraform-provider-gcore
    License
    Notes
    This Pulumi package is based on the gcore Terraform Provider.
    gcore logo
    gcore 0.22.0 published on Wednesday, Apr 30, 2025 by g-core
    g-core/terraform-provider-gcore