1. Packages
  2. Gcore Provider
  3. API Docs
  4. CloudVolume
Viewing docs for gcore 2.0.0-alpha.3
published on Monday, Mar 30, 2026 by g-core
Schema (JSON)
g-core/terraform-provider-gcore

gcore.CloudVolume

Viewing docs for gcore 2.0.0-alpha.3
published on Monday, Mar 30, 2026 by g-core
Schema (JSON)
g-core/terraform-provider-gcore

    Volumes are block storage devices that can be attached to instances as boot or data disks, with support for resizing and type changes.

    Example Usage

    Boot volume from image

    Creates a boot volume from an OS image.

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

// Create a boot volume from an image
const bootVolume = new gcore.CloudVolume("boot_volume", {
    projectId: 1,
    regionId: 1,
    name: "my-boot-volume",
    source: "image",
    imageId: "6dc4e521-0c72-462f-b2d4-306bcf15e227",
    size: 20,
    typeName: "ssd_hiiops",
    tags: {
        environment: "production",
    },
});

    import pulumi
import pulumi_gcore as gcore

# Create a boot volume from an image
boot_volume = gcore.CloudVolume("boot_volume",
    project_id=1,
    region_id=1,
    name="my-boot-volume",
    source="image",
    image_id="6dc4e521-0c72-462f-b2d4-306bcf15e227",
    size=20,
    type_name="ssd_hiiops",
    tags={
        "environment": "production",
    })

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/gcore/v2/gcore"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Create a boot volume from an image
		_, err := gcore.NewCloudVolume(ctx, "boot_volume", &gcore.CloudVolumeArgs{
			ProjectId: pulumi.Float64(1),
			RegionId:  pulumi.Float64(1),
			Name:      pulumi.String("my-boot-volume"),
			Source:    pulumi.String("image"),
			ImageId:   pulumi.String("6dc4e521-0c72-462f-b2d4-306bcf15e227"),
			Size:      pulumi.Float64(20),
			TypeName:  pulumi.String("ssd_hiiops"),
			Tags: pulumi.StringMap{
				"environment": pulumi.String("production"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcore = Pulumi.Gcore;

return await Deployment.RunAsync(() => 
{
    // Create a boot volume from an image
    var bootVolume = new Gcore.CloudVolume("boot_volume", new()
    {
        ProjectId = 1,
        RegionId = 1,
        Name = "my-boot-volume",
        Source = "image",
        ImageId = "6dc4e521-0c72-462f-b2d4-306bcf15e227",
        Size = 20,
        TypeName = "ssd_hiiops",
        Tags = 
        {
            { "environment", "production" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcore.CloudVolume;
import com.pulumi.gcore.CloudVolumeArgs;
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) {
        // Create a boot volume from an image
        var bootVolume = new CloudVolume("bootVolume", CloudVolumeArgs.builder()
            .projectId(1.0)
            .regionId(1.0)
            .name("my-boot-volume")
            .source("image")
            .imageId("6dc4e521-0c72-462f-b2d4-306bcf15e227")
            .size(20.0)
            .typeName("ssd_hiiops")
            .tags(Map.of("environment", "production"))
            .build());

    }
}

    resources:
  # Create a boot volume from an image
  bootVolume:
    type: gcore:CloudVolume
    name: boot_volume
    properties:
      projectId: 1
      regionId: 1
      name: my-boot-volume
      source: image
      imageId: 6dc4e521-0c72-462f-b2d4-306bcf15e227
      size: 20
      typeName: ssd_hiiops
      tags:
        environment: production

    Standalone data volume

    Creates a blank data volume for additional storage.

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

// Create a standalone data volume
const dataVolume = new gcore.CloudVolume("data_volume", {
    projectId: 1,
    regionId: 1,
    name: "my-data-volume",
    source: "new-volume",
    size: 50,
    typeName: "standard",
});

    import pulumi
import pulumi_gcore as gcore

# Create a standalone data volume
data_volume = gcore.CloudVolume("data_volume",
    project_id=1,
    region_id=1,
    name="my-data-volume",
    source="new-volume",
    size=50,
    type_name="standard")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/gcore/v2/gcore"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Create a standalone data volume
		_, err := gcore.NewCloudVolume(ctx, "data_volume", &gcore.CloudVolumeArgs{
			ProjectId: pulumi.Float64(1),
			RegionId:  pulumi.Float64(1),
			Name:      pulumi.String("my-data-volume"),
			Source:    pulumi.String("new-volume"),
			Size:      pulumi.Float64(50),
			TypeName:  pulumi.String("standard"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcore = Pulumi.Gcore;

return await Deployment.RunAsync(() => 
{
    // Create a standalone data volume
    var dataVolume = new Gcore.CloudVolume("data_volume", new()
    {
        ProjectId = 1,
        RegionId = 1,
        Name = "my-data-volume",
        Source = "new-volume",
        Size = 50,
        TypeName = "standard",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcore.CloudVolume;
import com.pulumi.gcore.CloudVolumeArgs;
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) {
        // Create a standalone data volume
        var dataVolume = new CloudVolume("dataVolume", CloudVolumeArgs.builder()
            .projectId(1.0)
            .regionId(1.0)
            .name("my-data-volume")
            .source("new-volume")
            .size(50.0)
            .typeName("standard")
            .build());

    }
}

    resources:
  # Create a standalone data volume
  dataVolume:
    type: gcore:CloudVolume
    name: data_volume
    properties:
      projectId: 1
      regionId: 1
      name: my-data-volume
      source: new-volume
      size: 50
      typeName: standard

    Create CloudVolume Resource

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

    Constructor syntax

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

@overload
def CloudVolume(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                source: Optional[str] = None,
                attachment_tag: Optional[str] = None,
                image_id: Optional[str] = None,
                instance_id_to_attach_to: Optional[str] = None,
                lifecycle_policy_ids: Optional[Sequence[float]] = None,
                name: Optional[str] = None,
                project_id: Optional[float] = None,
                region_id: Optional[float] = None,
                size: Optional[float] = None,
                snapshot_id: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = None,
                type_name: Optional[str] = None)
    func NewCloudVolume(ctx *Context, name string, args CloudVolumeArgs, opts ...ResourceOption) (*CloudVolume, error)
    public CloudVolume(string name, CloudVolumeArgs args, CustomResourceOptions? opts = null)
    public CloudVolume(String name, CloudVolumeArgs args)
public CloudVolume(String name, CloudVolumeArgs args, CustomResourceOptions options)

    type: gcore:CloudVolume
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 CloudVolumeArgs
    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 CloudVolumeArgs
    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 CloudVolumeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CloudVolumeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CloudVolumeArgs
    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 cloudVolumeResource = new Gcore.Index.CloudVolume("cloudVolumeResource", new()
{
    Source = "string",
    AttachmentTag = "string",
    ImageId = "string",
    InstanceIdToAttachTo = "string",
    LifecyclePolicyIds = new[]
    {
        0,
    },
    Name = "string",
    ProjectId = 0,
    RegionId = 0,
    Size = 0,
    SnapshotId = "string",
    Tags = 
    {
        { "string", "string" },
    },
    TypeName = "string",
});

    example, err := gcore.NewCloudVolume(ctx, "cloudVolumeResource", &gcore.CloudVolumeArgs{
	Source:               pulumi.String("string"),
	AttachmentTag:        pulumi.String("string"),
	ImageId:              pulumi.String("string"),
	InstanceIdToAttachTo: pulumi.String("string"),
	LifecyclePolicyIds: pulumi.Float64Array{
		pulumi.Float64(0),
	},
	Name:       pulumi.String("string"),
	ProjectId:  pulumi.Float64(0),
	RegionId:   pulumi.Float64(0),
	Size:       pulumi.Float64(0),
	SnapshotId: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	TypeName: pulumi.String("string"),
})

    var cloudVolumeResource = new CloudVolume("cloudVolumeResource", CloudVolumeArgs.builder()
    .source("string")
    .attachmentTag("string")
    .imageId("string")
    .instanceIdToAttachTo("string")
    .lifecyclePolicyIds(0.0)
    .name("string")
    .projectId(0.0)
    .regionId(0.0)
    .size(0.0)
    .snapshotId("string")
    .tags(Map.of("string", "string"))
    .typeName("string")
    .build());

    cloud_volume_resource = gcore.CloudVolume("cloudVolumeResource",
    source="string",
    attachment_tag="string",
    image_id="string",
    instance_id_to_attach_to="string",
    lifecycle_policy_ids=[0],
    name="string",
    project_id=0,
    region_id=0,
    size=0,
    snapshot_id="string",
    tags={
        "string": "string",
    },
    type_name="string")

    const cloudVolumeResource = new gcore.CloudVolume("cloudVolumeResource", {
    source: "string",
    attachmentTag: "string",
    imageId: "string",
    instanceIdToAttachTo: "string",
    lifecyclePolicyIds: [0],
    name: "string",
    projectId: 0,
    regionId: 0,
    size: 0,
    snapshotId: "string",
    tags: {
        string: "string",
    },
    typeName: "string",
});

    type: gcore:CloudVolume
properties:
    attachmentTag: string
    imageId: string
    instanceIdToAttachTo: string
    lifecyclePolicyIds:
        - 0
    name: string
    projectId: 0
    regionId: 0
    size: 0
    snapshotId: string
    source: string
    tags:
        string: string
    typeName: string

    CloudVolume 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 CloudVolume resource accepts the following input properties:

    Source string
    Volume source type Available values: "image", "snapshot", "new-volume".
    AttachmentTag string
    Block device attachment tag (not exposed in the user tags). Only used in conjunction with instance_id_to_attach_to
    ImageId string
    Image ID
    InstanceIdToAttachTo string
    instance_id to attach newly-created volume to
    LifecyclePolicyIds List<double>
    List of lifecycle policy IDs (snapshot creation schedules) to associate with the volume
    Name string
    Volume name
    ProjectId double
    Project ID
    RegionId double
    Region ID
    Size double
    Volume size in GiB
    SnapshotId string
    Snapshot ID
    Tags Dictionary<string, string>
    Key-value tags to associate with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Both tag keys and values have a maximum length of 255 characters. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
    TypeName string
    Volume type. Defaults to standard. If not specified for source snapshot, volume type will be derived from the snapshot volume. Available values: "cold", "ssdhiiops", "ssdlocal", "ssd_lowlatency", "standard", "ultra".
    Source string
    Volume source type Available values: "image", "snapshot", "new-volume".
    AttachmentTag string
    Block device attachment tag (not exposed in the user tags). Only used in conjunction with instance_id_to_attach_to
    ImageId string
    Image ID
    InstanceIdToAttachTo string
    instance_id to attach newly-created volume to
    LifecyclePolicyIds []float64
    List of lifecycle policy IDs (snapshot creation schedules) to associate with the volume
    Name string
    Volume name
    ProjectId float64
    Project ID
    RegionId float64
    Region ID
    Size float64
    Volume size in GiB
    SnapshotId string
    Snapshot ID
    Tags map[string]string
    Key-value tags to associate with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Both tag keys and values have a maximum length of 255 characters. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
    TypeName string
    Volume type. Defaults to standard. If not specified for source snapshot, volume type will be derived from the snapshot volume. Available values: "cold", "ssdhiiops", "ssdlocal", "ssd_lowlatency", "standard", "ultra".
    source String
    Volume source type Available values: "image", "snapshot", "new-volume".
    attachmentTag String
    Block device attachment tag (not exposed in the user tags). Only used in conjunction with instance_id_to_attach_to
    imageId String
    Image ID
    instanceIdToAttachTo String
    instance_id to attach newly-created volume to
    lifecyclePolicyIds List<Double>
    List of lifecycle policy IDs (snapshot creation schedules) to associate with the volume
    name String
    Volume name
    projectId Double
    Project ID
    regionId Double
    Region ID
    size Double
    Volume size in GiB
    snapshotId String
    Snapshot ID
    tags Map<String,String>
    Key-value tags to associate with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Both tag keys and values have a maximum length of 255 characters. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
    typeName String
    Volume type. Defaults to standard. If not specified for source snapshot, volume type will be derived from the snapshot volume. Available values: "cold", "ssdhiiops", "ssdlocal", "ssd_lowlatency", "standard", "ultra".
    source string
    Volume source type Available values: "image", "snapshot", "new-volume".
    attachmentTag string
    Block device attachment tag (not exposed in the user tags). Only used in conjunction with instance_id_to_attach_to
    imageId string
    Image ID
    instanceIdToAttachTo string
    instance_id to attach newly-created volume to
    lifecyclePolicyIds number[]
    List of lifecycle policy IDs (snapshot creation schedules) to associate with the volume
    name string
    Volume name
    projectId number
    Project ID
    regionId number
    Region ID
    size number
    Volume size in GiB
    snapshotId string
    Snapshot ID
    tags {[key: string]: string}
    Key-value tags to associate with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Both tag keys and values have a maximum length of 255 characters. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
    typeName string
    Volume type. Defaults to standard. If not specified for source snapshot, volume type will be derived from the snapshot volume. Available values: "cold", "ssdhiiops", "ssdlocal", "ssd_lowlatency", "standard", "ultra".
    source str
    Volume source type Available values: "image", "snapshot", "new-volume".
    attachment_tag str
    Block device attachment tag (not exposed in the user tags). Only used in conjunction with instance_id_to_attach_to
    image_id str
    Image ID
    instance_id_to_attach_to str
    instance_id to attach newly-created volume to
    lifecycle_policy_ids Sequence[float]
    List of lifecycle policy IDs (snapshot creation schedules) to associate with the volume
    name str
    Volume name
    project_id float
    Project ID
    region_id float
    Region ID
    size float
    Volume size in GiB
    snapshot_id str
    Snapshot ID
    tags Mapping[str, str]
    Key-value tags to associate with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Both tag keys and values have a maximum length of 255 characters. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
    type_name str
    Volume type. Defaults to standard. If not specified for source snapshot, volume type will be derived from the snapshot volume. Available values: "cold", "ssdhiiops", "ssdlocal", "ssd_lowlatency", "standard", "ultra".
    source String
    Volume source type Available values: "image", "snapshot", "new-volume".
    attachmentTag String
    Block device attachment tag (not exposed in the user tags). Only used in conjunction with instance_id_to_attach_to
    imageId String
    Image ID
    instanceIdToAttachTo String
    instance_id to attach newly-created volume to
    lifecyclePolicyIds List<Number>
    List of lifecycle policy IDs (snapshot creation schedules) to associate with the volume
    name String
    Volume name
    projectId Number
    Project ID
    regionId Number
    Region ID
    size Number
    Volume size in GiB
    snapshotId String
    Snapshot ID
    tags Map<String>
    Key-value tags to associate with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Both tag keys and values have a maximum length of 255 characters. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
    typeName String
    Volume type. Defaults to standard. If not specified for source snapshot, volume type will be derived from the snapshot volume. Available values: "cold", "ssdhiiops", "ssdlocal", "ssd_lowlatency", "standard", "ultra".

    Outputs

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

    Attachments List<CloudVolumeAttachment>
    List of attachments associated with the volume.
    Bootable bool
    Indicates whether the volume is bootable.
    CreatedAt string
    The date and time when the volume was created.
    CreatorTaskId string
    The ID of the task that created this volume.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsRootVolume bool
    Indicates whether this is a root volume.
    LimiterStats CloudVolumeLimiterStats
    Schema representing the Quality of Service (QoS) parameters for a volume.
    Region string
    The region where the volume is located.
    SnapshotIds List<string>
    List of snapshot IDs associated with this volume.
    Status string
    The current status of the volume. Available values: "attaching", "available", "awaiting-transfer", "backing-up", "creating", "deleting", "detaching", "downloading", "error", "errorbacking-up", "errordeleting", "errorextending", "errorrestoring", "extending", "in-use", "maintenance", "reserved", "restoring-backup", "retyping", "reverting", "uploading".
    UpdatedAt string
    The date and time when the volume was last updated.
    VolumeImageMetadata Dictionary<string, string>
    Image metadata for volumes created from an image.
    VolumeType string
    The type of volume storage.
    Attachments []CloudVolumeAttachment
    List of attachments associated with the volume.
    Bootable bool
    Indicates whether the volume is bootable.
    CreatedAt string
    The date and time when the volume was created.
    CreatorTaskId string
    The ID of the task that created this volume.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsRootVolume bool
    Indicates whether this is a root volume.
    LimiterStats CloudVolumeLimiterStats
    Schema representing the Quality of Service (QoS) parameters for a volume.
    Region string
    The region where the volume is located.
    SnapshotIds []string
    List of snapshot IDs associated with this volume.
    Status string
    The current status of the volume. Available values: "attaching", "available", "awaiting-transfer", "backing-up", "creating", "deleting", "detaching", "downloading", "error", "errorbacking-up", "errordeleting", "errorextending", "errorrestoring", "extending", "in-use", "maintenance", "reserved", "restoring-backup", "retyping", "reverting", "uploading".
    UpdatedAt string
    The date and time when the volume was last updated.
    VolumeImageMetadata map[string]string
    Image metadata for volumes created from an image.
    VolumeType string
    The type of volume storage.
    attachments List<CloudVolumeAttachment>
    List of attachments associated with the volume.
    bootable Boolean
    Indicates whether the volume is bootable.
    createdAt String
    The date and time when the volume was created.
    creatorTaskId String
    The ID of the task that created this volume.
    id String
    The provider-assigned unique ID for this managed resource.
    isRootVolume Boolean
    Indicates whether this is a root volume.
    limiterStats CloudVolumeLimiterStats
    Schema representing the Quality of Service (QoS) parameters for a volume.
    region String
    The region where the volume is located.
    snapshotIds List<String>
    List of snapshot IDs associated with this volume.
    status String
    The current status of the volume. Available values: "attaching", "available", "awaiting-transfer", "backing-up", "creating", "deleting", "detaching", "downloading", "error", "errorbacking-up", "errordeleting", "errorextending", "errorrestoring", "extending", "in-use", "maintenance", "reserved", "restoring-backup", "retyping", "reverting", "uploading".
    updatedAt String
    The date and time when the volume was last updated.
    volumeImageMetadata Map<String,String>
    Image metadata for volumes created from an image.
    volumeType String
    The type of volume storage.
    attachments CloudVolumeAttachment[]
    List of attachments associated with the volume.
    bootable boolean
    Indicates whether the volume is bootable.
    createdAt string
    The date and time when the volume was created.
    creatorTaskId string
    The ID of the task that created this volume.
    id string
    The provider-assigned unique ID for this managed resource.
    isRootVolume boolean
    Indicates whether this is a root volume.
    limiterStats CloudVolumeLimiterStats
    Schema representing the Quality of Service (QoS) parameters for a volume.
    region string
    The region where the volume is located.
    snapshotIds string[]
    List of snapshot IDs associated with this volume.
    status string
    The current status of the volume. Available values: "attaching", "available", "awaiting-transfer", "backing-up", "creating", "deleting", "detaching", "downloading", "error", "errorbacking-up", "errordeleting", "errorextending", "errorrestoring", "extending", "in-use", "maintenance", "reserved", "restoring-backup", "retyping", "reverting", "uploading".
    updatedAt string
    The date and time when the volume was last updated.
    volumeImageMetadata {[key: string]: string}
    Image metadata for volumes created from an image.
    volumeType string
    The type of volume storage.
    attachments Sequence[CloudVolumeAttachment]
    List of attachments associated with the volume.
    bootable bool
    Indicates whether the volume is bootable.
    created_at str
    The date and time when the volume was created.
    creator_task_id str
    The ID of the task that created this volume.
    id str
    The provider-assigned unique ID for this managed resource.
    is_root_volume bool
    Indicates whether this is a root volume.
    limiter_stats CloudVolumeLimiterStats
    Schema representing the Quality of Service (QoS) parameters for a volume.
    region str
    The region where the volume is located.
    snapshot_ids Sequence[str]
    List of snapshot IDs associated with this volume.
    status str
    The current status of the volume. Available values: "attaching", "available", "awaiting-transfer", "backing-up", "creating", "deleting", "detaching", "downloading", "error", "errorbacking-up", "errordeleting", "errorextending", "errorrestoring", "extending", "in-use", "maintenance", "reserved", "restoring-backup", "retyping", "reverting", "uploading".
    updated_at str
    The date and time when the volume was last updated.
    volume_image_metadata Mapping[str, str]
    Image metadata for volumes created from an image.
    volume_type str
    The type of volume storage.
    attachments List<Property Map>
    List of attachments associated with the volume.
    bootable Boolean
    Indicates whether the volume is bootable.
    createdAt String
    The date and time when the volume was created.
    creatorTaskId String
    The ID of the task that created this volume.
    id String
    The provider-assigned unique ID for this managed resource.
    isRootVolume Boolean
    Indicates whether this is a root volume.
    limiterStats Property Map
    Schema representing the Quality of Service (QoS) parameters for a volume.
    region String
    The region where the volume is located.
    snapshotIds List<String>
    List of snapshot IDs associated with this volume.
    status String
    The current status of the volume. Available values: "attaching", "available", "awaiting-transfer", "backing-up", "creating", "deleting", "detaching", "downloading", "error", "errorbacking-up", "errordeleting", "errorextending", "errorrestoring", "extending", "in-use", "maintenance", "reserved", "restoring-backup", "retyping", "reverting", "uploading".
    updatedAt String
    The date and time when the volume was last updated.
    volumeImageMetadata Map<String>
    Image metadata for volumes created from an image.
    volumeType String
    The type of volume storage.

    Look up Existing CloudVolume Resource

    Get an existing CloudVolume 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?: CloudVolumeState, opts?: CustomResourceOptions): CloudVolume
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        attachment_tag: Optional[str] = None,
        attachments: Optional[Sequence[CloudVolumeAttachmentArgs]] = None,
        bootable: Optional[bool] = None,
        created_at: Optional[str] = None,
        creator_task_id: Optional[str] = None,
        image_id: Optional[str] = None,
        instance_id_to_attach_to: Optional[str] = None,
        is_root_volume: Optional[bool] = None,
        lifecycle_policy_ids: Optional[Sequence[float]] = None,
        limiter_stats: Optional[CloudVolumeLimiterStatsArgs] = None,
        name: Optional[str] = None,
        project_id: Optional[float] = None,
        region: Optional[str] = None,
        region_id: Optional[float] = None,
        size: Optional[float] = None,
        snapshot_id: Optional[str] = None,
        snapshot_ids: Optional[Sequence[str]] = None,
        source: Optional[str] = None,
        status: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        type_name: Optional[str] = None,
        updated_at: Optional[str] = None,
        volume_image_metadata: Optional[Mapping[str, str]] = None,
        volume_type: Optional[str] = None) -> CloudVolume
    func GetCloudVolume(ctx *Context, name string, id IDInput, state *CloudVolumeState, opts ...ResourceOption) (*CloudVolume, error)
    public static CloudVolume Get(string name, Input<string> id, CloudVolumeState? state, CustomResourceOptions? opts = null)
    public static CloudVolume get(String name, Output<String> id, CloudVolumeState state, CustomResourceOptions options)
    resources:  _:    type: gcore:CloudVolume    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:
    AttachmentTag string
    Block device attachment tag (not exposed in the user tags). Only used in conjunction with instance_id_to_attach_to
    Attachments List<CloudVolumeAttachment>
    List of attachments associated with the volume.
    Bootable bool
    Indicates whether the volume is bootable.
    CreatedAt string
    The date and time when the volume was created.
    CreatorTaskId string
    The ID of the task that created this volume.
    ImageId string
    Image ID
    InstanceIdToAttachTo string
    instance_id to attach newly-created volume to
    IsRootVolume bool
    Indicates whether this is a root volume.
    LifecyclePolicyIds List<double>
    List of lifecycle policy IDs (snapshot creation schedules) to associate with the volume
    LimiterStats CloudVolumeLimiterStats
    Schema representing the Quality of Service (QoS) parameters for a volume.
    Name string
    Volume name
    ProjectId double
    Project ID
    Region string
    The region where the volume is located.
    RegionId double
    Region ID
    Size double
    Volume size in GiB
    SnapshotId string
    Snapshot ID
    SnapshotIds List<string>
    List of snapshot IDs associated with this volume.
    Source string
    Volume source type Available values: "image", "snapshot", "new-volume".
    Status string
    The current status of the volume. Available values: "attaching", "available", "awaiting-transfer", "backing-up", "creating", "deleting", "detaching", "downloading", "error", "errorbacking-up", "errordeleting", "errorextending", "errorrestoring", "extending", "in-use", "maintenance", "reserved", "restoring-backup", "retyping", "reverting", "uploading".
    Tags Dictionary<string, string>
    Key-value tags to associate with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Both tag keys and values have a maximum length of 255 characters. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
    TypeName string
    Volume type. Defaults to standard. If not specified for source snapshot, volume type will be derived from the snapshot volume. Available values: "cold", "ssdhiiops", "ssdlocal", "ssd_lowlatency", "standard", "ultra".
    UpdatedAt string
    The date and time when the volume was last updated.
    VolumeImageMetadata Dictionary<string, string>
    Image metadata for volumes created from an image.
    VolumeType string
    The type of volume storage.
    AttachmentTag string
    Block device attachment tag (not exposed in the user tags). Only used in conjunction with instance_id_to_attach_to
    Attachments []CloudVolumeAttachmentArgs
    List of attachments associated with the volume.
    Bootable bool
    Indicates whether the volume is bootable.
    CreatedAt string
    The date and time when the volume was created.
    CreatorTaskId string
    The ID of the task that created this volume.
    ImageId string
    Image ID
    InstanceIdToAttachTo string
    instance_id to attach newly-created volume to
    IsRootVolume bool
    Indicates whether this is a root volume.
    LifecyclePolicyIds []float64
    List of lifecycle policy IDs (snapshot creation schedules) to associate with the volume
    LimiterStats CloudVolumeLimiterStatsArgs
    Schema representing the Quality of Service (QoS) parameters for a volume.
    Name string
    Volume name
    ProjectId float64
    Project ID
    Region string
    The region where the volume is located.
    RegionId float64
    Region ID
    Size float64
    Volume size in GiB
    SnapshotId string
    Snapshot ID
    SnapshotIds []string
    List of snapshot IDs associated with this volume.
    Source string
    Volume source type Available values: "image", "snapshot", "new-volume".
    Status string
    The current status of the volume. Available values: "attaching", "available", "awaiting-transfer", "backing-up", "creating", "deleting", "detaching", "downloading", "error", "errorbacking-up", "errordeleting", "errorextending", "errorrestoring", "extending", "in-use", "maintenance", "reserved", "restoring-backup", "retyping", "reverting", "uploading".
    Tags map[string]string
    Key-value tags to associate with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Both tag keys and values have a maximum length of 255 characters. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
    TypeName string
    Volume type. Defaults to standard. If not specified for source snapshot, volume type will be derived from the snapshot volume. Available values: "cold", "ssdhiiops", "ssdlocal", "ssd_lowlatency", "standard", "ultra".
    UpdatedAt string
    The date and time when the volume was last updated.
    VolumeImageMetadata map[string]string
    Image metadata for volumes created from an image.
    VolumeType string
    The type of volume storage.
    attachmentTag String
    Block device attachment tag (not exposed in the user tags). Only used in conjunction with instance_id_to_attach_to
    attachments List<CloudVolumeAttachment>
    List of attachments associated with the volume.
    bootable Boolean
    Indicates whether the volume is bootable.
    createdAt String
    The date and time when the volume was created.
    creatorTaskId String
    The ID of the task that created this volume.
    imageId String
    Image ID
    instanceIdToAttachTo String
    instance_id to attach newly-created volume to
    isRootVolume Boolean
    Indicates whether this is a root volume.
    lifecyclePolicyIds List<Double>
    List of lifecycle policy IDs (snapshot creation schedules) to associate with the volume
    limiterStats CloudVolumeLimiterStats
    Schema representing the Quality of Service (QoS) parameters for a volume.
    name String
    Volume name
    projectId Double
    Project ID
    region String
    The region where the volume is located.
    regionId Double
    Region ID
    size Double
    Volume size in GiB
    snapshotId String
    Snapshot ID
    snapshotIds List<String>
    List of snapshot IDs associated with this volume.
    source String
    Volume source type Available values: "image", "snapshot", "new-volume".
    status String
    The current status of the volume. Available values: "attaching", "available", "awaiting-transfer", "backing-up", "creating", "deleting", "detaching", "downloading", "error", "errorbacking-up", "errordeleting", "errorextending", "errorrestoring", "extending", "in-use", "maintenance", "reserved", "restoring-backup", "retyping", "reverting", "uploading".
    tags Map<String,String>
    Key-value tags to associate with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Both tag keys and values have a maximum length of 255 characters. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
    typeName String
    Volume type. Defaults to standard. If not specified for source snapshot, volume type will be derived from the snapshot volume. Available values: "cold", "ssdhiiops", "ssdlocal", "ssd_lowlatency", "standard", "ultra".
    updatedAt String
    The date and time when the volume was last updated.
    volumeImageMetadata Map<String,String>
    Image metadata for volumes created from an image.
    volumeType String
    The type of volume storage.
    attachmentTag string
    Block device attachment tag (not exposed in the user tags). Only used in conjunction with instance_id_to_attach_to
    attachments CloudVolumeAttachment[]
    List of attachments associated with the volume.
    bootable boolean
    Indicates whether the volume is bootable.
    createdAt string
    The date and time when the volume was created.
    creatorTaskId string
    The ID of the task that created this volume.
    imageId string
    Image ID
    instanceIdToAttachTo string
    instance_id to attach newly-created volume to
    isRootVolume boolean
    Indicates whether this is a root volume.
    lifecyclePolicyIds number[]
    List of lifecycle policy IDs (snapshot creation schedules) to associate with the volume
    limiterStats CloudVolumeLimiterStats
    Schema representing the Quality of Service (QoS) parameters for a volume.
    name string
    Volume name
    projectId number
    Project ID
    region string
    The region where the volume is located.
    regionId number
    Region ID
    size number
    Volume size in GiB
    snapshotId string
    Snapshot ID
    snapshotIds string[]
    List of snapshot IDs associated with this volume.
    source string
    Volume source type Available values: "image", "snapshot", "new-volume".
    status string
    The current status of the volume. Available values: "attaching", "available", "awaiting-transfer", "backing-up", "creating", "deleting", "detaching", "downloading", "error", "errorbacking-up", "errordeleting", "errorextending", "errorrestoring", "extending", "in-use", "maintenance", "reserved", "restoring-backup", "retyping", "reverting", "uploading".
    tags {[key: string]: string}
    Key-value tags to associate with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Both tag keys and values have a maximum length of 255 characters. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
    typeName string
    Volume type. Defaults to standard. If not specified for source snapshot, volume type will be derived from the snapshot volume. Available values: "cold", "ssdhiiops", "ssdlocal", "ssd_lowlatency", "standard", "ultra".
    updatedAt string
    The date and time when the volume was last updated.
    volumeImageMetadata {[key: string]: string}
    Image metadata for volumes created from an image.
    volumeType string
    The type of volume storage.
    attachment_tag str
    Block device attachment tag (not exposed in the user tags). Only used in conjunction with instance_id_to_attach_to
    attachments Sequence[CloudVolumeAttachmentArgs]
    List of attachments associated with the volume.
    bootable bool
    Indicates whether the volume is bootable.
    created_at str
    The date and time when the volume was created.
    creator_task_id str
    The ID of the task that created this volume.
    image_id str
    Image ID
    instance_id_to_attach_to str
    instance_id to attach newly-created volume to
    is_root_volume bool
    Indicates whether this is a root volume.
    lifecycle_policy_ids Sequence[float]
    List of lifecycle policy IDs (snapshot creation schedules) to associate with the volume
    limiter_stats CloudVolumeLimiterStatsArgs
    Schema representing the Quality of Service (QoS) parameters for a volume.
    name str
    Volume name
    project_id float
    Project ID
    region str
    The region where the volume is located.
    region_id float
    Region ID
    size float
    Volume size in GiB
    snapshot_id str
    Snapshot ID
    snapshot_ids Sequence[str]
    List of snapshot IDs associated with this volume.
    source str
    Volume source type Available values: "image", "snapshot", "new-volume".
    status str
    The current status of the volume. Available values: "attaching", "available", "awaiting-transfer", "backing-up", "creating", "deleting", "detaching", "downloading", "error", "errorbacking-up", "errordeleting", "errorextending", "errorrestoring", "extending", "in-use", "maintenance", "reserved", "restoring-backup", "retyping", "reverting", "uploading".
    tags Mapping[str, str]
    Key-value tags to associate with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Both tag keys and values have a maximum length of 255 characters. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
    type_name str
    Volume type. Defaults to standard. If not specified for source snapshot, volume type will be derived from the snapshot volume. Available values: "cold", "ssdhiiops", "ssdlocal", "ssd_lowlatency", "standard", "ultra".
    updated_at str
    The date and time when the volume was last updated.
    volume_image_metadata Mapping[str, str]
    Image metadata for volumes created from an image.
    volume_type str
    The type of volume storage.
    attachmentTag String
    Block device attachment tag (not exposed in the user tags). Only used in conjunction with instance_id_to_attach_to
    attachments List<Property Map>
    List of attachments associated with the volume.
    bootable Boolean
    Indicates whether the volume is bootable.
    createdAt String
    The date and time when the volume was created.
    creatorTaskId String
    The ID of the task that created this volume.
    imageId String
    Image ID
    instanceIdToAttachTo String
    instance_id to attach newly-created volume to
    isRootVolume Boolean
    Indicates whether this is a root volume.
    lifecyclePolicyIds List<Number>
    List of lifecycle policy IDs (snapshot creation schedules) to associate with the volume
    limiterStats Property Map
    Schema representing the Quality of Service (QoS) parameters for a volume.
    name String
    Volume name
    projectId Number
    Project ID
    region String
    The region where the volume is located.
    regionId Number
    Region ID
    size Number
    Volume size in GiB
    snapshotId String
    Snapshot ID
    snapshotIds List<String>
    List of snapshot IDs associated with this volume.
    source String
    Volume source type Available values: "image", "snapshot", "new-volume".
    status String
    The current status of the volume. Available values: "attaching", "available", "awaiting-transfer", "backing-up", "creating", "deleting", "detaching", "downloading", "error", "errorbacking-up", "errordeleting", "errorextending", "errorrestoring", "extending", "in-use", "maintenance", "reserved", "restoring-backup", "retyping", "reverting", "uploading".
    tags Map<String>
    Key-value tags to associate with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Both tag keys and values have a maximum length of 255 characters. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
    typeName String
    Volume type. Defaults to standard. If not specified for source snapshot, volume type will be derived from the snapshot volume. Available values: "cold", "ssdhiiops", "ssdlocal", "ssd_lowlatency", "standard", "ultra".
    updatedAt String
    The date and time when the volume was last updated.
    volumeImageMetadata Map<String>
    Image metadata for volumes created from an image.
    volumeType String
    The type of volume storage.

    Supporting Types

    CloudVolumeAttachment, CloudVolumeAttachmentArgs

    AttachedAt string
    The date and time when the attachment was created.
    AttachmentId string
    The unique identifier of the attachment object.
    Device string
    The block device name inside the guest instance.
    FlavorId string
    The flavor ID of the instance.
    InstanceName string
    The name of the instance if attached and the server name is known.
    ServerId string
    The unique identifier of the instance.
    VolumeId string
    The unique identifier of the attached volume.
    AttachedAt string
    The date and time when the attachment was created.
    AttachmentId string
    The unique identifier of the attachment object.
    Device string
    The block device name inside the guest instance.
    FlavorId string
    The flavor ID of the instance.
    InstanceName string
    The name of the instance if attached and the server name is known.
    ServerId string
    The unique identifier of the instance.
    VolumeId string
    The unique identifier of the attached volume.
    attachedAt String
    The date and time when the attachment was created.
    attachmentId String
    The unique identifier of the attachment object.
    device String
    The block device name inside the guest instance.
    flavorId String
    The flavor ID of the instance.
    instanceName String
    The name of the instance if attached and the server name is known.
    serverId String
    The unique identifier of the instance.
    volumeId String
    The unique identifier of the attached volume.
    attachedAt string
    The date and time when the attachment was created.
    attachmentId string
    The unique identifier of the attachment object.
    device string
    The block device name inside the guest instance.
    flavorId string
    The flavor ID of the instance.
    instanceName string
    The name of the instance if attached and the server name is known.
    serverId string
    The unique identifier of the instance.
    volumeId string
    The unique identifier of the attached volume.
    attached_at str
    The date and time when the attachment was created.
    attachment_id str
    The unique identifier of the attachment object.
    device str
    The block device name inside the guest instance.
    flavor_id str
    The flavor ID of the instance.
    instance_name str
    The name of the instance if attached and the server name is known.
    server_id str
    The unique identifier of the instance.
    volume_id str
    The unique identifier of the attached volume.
    attachedAt String
    The date and time when the attachment was created.
    attachmentId String
    The unique identifier of the attachment object.
    device String
    The block device name inside the guest instance.
    flavorId String
    The flavor ID of the instance.
    instanceName String
    The name of the instance if attached and the server name is known.
    serverId String
    The unique identifier of the instance.
    volumeId String
    The unique identifier of the attached volume.

    CloudVolumeLimiterStats, CloudVolumeLimiterStatsArgs

    IopsBaseLimit double
    The sustained IOPS (Input/Output Operations Per Second) limit.
    IopsBurstLimit double
    The burst IOPS limit.
    MBpsBaseLimit double
    The sustained bandwidth limit in megabytes per second (MBps).
    MBpsBurstLimit double
    The burst bandwidth limit in megabytes per second (MBps).
    IopsBaseLimit float64
    The sustained IOPS (Input/Output Operations Per Second) limit.
    IopsBurstLimit float64
    The burst IOPS limit.
    MBpsBaseLimit float64
    The sustained bandwidth limit in megabytes per second (MBps).
    MBpsBurstLimit float64
    The burst bandwidth limit in megabytes per second (MBps).
    iopsBaseLimit Double
    The sustained IOPS (Input/Output Operations Per Second) limit.
    iopsBurstLimit Double
    The burst IOPS limit.
    mBpsBaseLimit Double
    The sustained bandwidth limit in megabytes per second (MBps).
    mBpsBurstLimit Double
    The burst bandwidth limit in megabytes per second (MBps).
    iopsBaseLimit number
    The sustained IOPS (Input/Output Operations Per Second) limit.
    iopsBurstLimit number
    The burst IOPS limit.
    mBpsBaseLimit number
    The sustained bandwidth limit in megabytes per second (MBps).
    mBpsBurstLimit number
    The burst bandwidth limit in megabytes per second (MBps).
    iops_base_limit float
    The sustained IOPS (Input/Output Operations Per Second) limit.
    iops_burst_limit float
    The burst IOPS limit.
    m_bps_base_limit float
    The sustained bandwidth limit in megabytes per second (MBps).
    m_bps_burst_limit float
    The burst bandwidth limit in megabytes per second (MBps).
    iopsBaseLimit Number
    The sustained IOPS (Input/Output Operations Per Second) limit.
    iopsBurstLimit Number
    The burst IOPS limit.
    mBpsBaseLimit Number
    The sustained bandwidth limit in megabytes per second (MBps).
    mBpsBurstLimit Number
    The burst bandwidth limit in megabytes per second (MBps).

    Import

    $ pulumi import gcore:index/cloudVolume:CloudVolume example '<project_id>/<region_id>/<volume_id>'

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

    Package Details

    Repository
    gcore g-core/terraform-provider-gcore
    License
    Notes
    This Pulumi package is based on the gcore Terraform Provider.
    Viewing docs for gcore 2.0.0-alpha.3
    published on Monday, Mar 30, 2026 by g-core
    Schema (JSON)
    g-core/terraform-provider-gcore
      Try Pulumi Cloud free. Your team will thank you.