OVHCloud v2.0.7, Mar 19 25

OVHCloud v2.0.7 published on Wednesday, Mar 19, 2025 by OVHcloud

ovh.CloudProject.Volume

Explore with Pulumi AI

OVHCloud v2.0.7 published on Wednesday, Mar 19, 2025 by OVHcloud

Create Volume Resource

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

Constructor syntax

new Volume(name: string, args: VolumeArgs, opts?: CustomResourceOptions);

@overload
def Volume(resource_name: str,
           args: VolumeArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Volume(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           region_name: Optional[str] = None,
           service_name: Optional[str] = None,
           description: Optional[str] = None,
           image_id: Optional[str] = None,
           instance_id: Optional[str] = None,
           name: Optional[str] = None,
           size: Optional[float] = None,
           snapshot_id: Optional[str] = None,
           type: Optional[str] = None,
           volume_id: Optional[str] = None)

func NewVolume(ctx *Context, name string, args VolumeArgs, opts ...ResourceOption) (*Volume, error)

public Volume(string name, VolumeArgs args, CustomResourceOptions? opts = null)

public Volume(String name, VolumeArgs args)
public Volume(String name, VolumeArgs args, CustomResourceOptions options)

type: ovh:CloudProject:Volume
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 VolumeArgs: 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 VolumeArgs: 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 VolumeArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args VolumeArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args VolumeArgs: 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 volumeResource = new Ovh.CloudProject.Volume("volumeResource", new()
{
    RegionName = "string",
    ServiceName = "string",
    Description = "string",
    ImageId = "string",
    InstanceId = "string",
    Name = "string",
    Size = 0,
    SnapshotId = "string",
    Type = "string",
    VolumeId = "string",
});

example, err := CloudProject.NewVolume(ctx, "volumeResource", &CloudProject.VolumeArgs{
	RegionName:  pulumi.String("string"),
	ServiceName: pulumi.String("string"),
	Description: pulumi.String("string"),
	ImageId:     pulumi.String("string"),
	InstanceId:  pulumi.String("string"),
	Name:        pulumi.String("string"),
	Size:        pulumi.Float64(0),
	SnapshotId:  pulumi.String("string"),
	Type:        pulumi.String("string"),
	VolumeId:    pulumi.String("string"),
})

var volumeResource = new Volume("volumeResource", VolumeArgs.builder()
    .regionName("string")
    .serviceName("string")
    .description("string")
    .imageId("string")
    .instanceId("string")
    .name("string")
    .size(0)
    .snapshotId("string")
    .type("string")
    .volumeId("string")
    .build());

volume_resource = ovh.cloud_project.Volume("volumeResource",
    region_name="string",
    service_name="string",
    description="string",
    image_id="string",
    instance_id="string",
    name="string",
    size=0,
    snapshot_id="string",
    type="string",
    volume_id="string")

const volumeResource = new ovh.cloudproject.Volume("volumeResource", {
    regionName: "string",
    serviceName: "string",
    description: "string",
    imageId: "string",
    instanceId: "string",
    name: "string",
    size: 0,
    snapshotId: "string",
    type: "string",
    volumeId: "string",
});

type: ovh:CloudProject:Volume
properties:
    description: string
    imageId: string
    instanceId: string
    name: string
    regionName: string
    serviceName: string
    size: 0
    snapshotId: string
    type: string
    volumeId: string

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

RegionName string: Region name
ServiceName string: Service name
Description string: Volume description
ImageId string: Image ID
InstanceId string: Instance ID
Name string: Volume name
Size double: Volume size
SnapshotId string: Snapshot ID
Type string: Type of the volume
VolumeId string: Volume ID

RegionName string: Region name
ServiceName string: Service name
Description string: Volume description
ImageId string: Image ID
InstanceId string: Instance ID
Name string: Volume name
Size float64: Volume size
SnapshotId string: Snapshot ID
Type string: Type of the volume
VolumeId string: Volume ID

regionName String: Region name
serviceName String: Service name
description String: Volume description
imageId String: Image ID
instanceId String: Instance ID
name String: Volume name
size Double: Volume size
snapshotId String: Snapshot ID
type String: Type of the volume
volumeId String: Volume ID

regionName string: Region name
serviceName string: Service name
description string: Volume description
imageId string: Image ID
instanceId string: Instance ID
name string: Volume name
size number: Volume size
snapshotId string: Snapshot ID
type string: Type of the volume
volumeId string: Volume ID

region_name str: Region name
service_name str: Service name
description str: Volume description
image_id str: Image ID
instance_id str: Instance ID
name str: Volume name
size float: Volume size
snapshot_id str: Snapshot ID
type str: Type of the volume
volume_id str: Volume ID

regionName String: Region name
serviceName String: Service name
description String: Volume description
imageId String: Image ID
instanceId String: Instance ID
name String: Volume name
size Number: Volume size
snapshotId String: Snapshot ID
type String: Type of the volume
volumeId String: Volume ID

Outputs

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

Action string: The action of the operation
CompletedAt string: The completed date of the operation
CreatedAt string: The creation date of the operation
Id string: The provider-assigned unique ID for this managed resource.
Progress double: Volume status
Regions List<string>: List of regions
ResourceId string: Id of the resource
StartedAt string: Datetime of the operation creation
Status string: Volume status
SubOperations List<VolumeSubOperation>: Sub-operations of the operation

Action string: The action of the operation
CompletedAt string: The completed date of the operation
CreatedAt string: The creation date of the operation
Id string: The provider-assigned unique ID for this managed resource.
Progress float64: Volume status
Regions []string: List of regions
ResourceId string: Id of the resource
StartedAt string: Datetime of the operation creation
Status string: Volume status
SubOperations []VolumeSubOperation: Sub-operations of the operation

action String: The action of the operation
completedAt String: The completed date of the operation
createdAt String: The creation date of the operation
id String: The provider-assigned unique ID for this managed resource.
progress Double: Volume status
regions List<String>: List of regions
resourceId String: Id of the resource
startedAt String: Datetime of the operation creation
status String: Volume status
subOperations List<VolumeSubOperation>: Sub-operations of the operation

action string: The action of the operation
completedAt string: The completed date of the operation
createdAt string: The creation date of the operation
id string: The provider-assigned unique ID for this managed resource.
progress number: Volume status
regions string[]: List of regions
resourceId string: Id of the resource
startedAt string: Datetime of the operation creation
status string: Volume status
subOperations VolumeSubOperation[]: Sub-operations of the operation

action str: The action of the operation
completed_at str: The completed date of the operation
created_at str: The creation date of the operation
id str: The provider-assigned unique ID for this managed resource.
progress float: Volume status
regions Sequence[str]: List of regions
resource_id str: Id of the resource
started_at str: Datetime of the operation creation
status str: Volume status
sub_operations Sequence[cloudproject.VolumeSubOperation]: Sub-operations of the operation

action String: The action of the operation
completedAt String: The completed date of the operation
createdAt String: The creation date of the operation
id String: The provider-assigned unique ID for this managed resource.
progress Number: Volume status
regions List<String>: List of regions
resourceId String: Id of the resource
startedAt String: Datetime of the operation creation
status String: Volume status
subOperations List<Property Map>: Sub-operations of the operation

Look up Existing Volume Resource

Get an existing Volume 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?: VolumeState, opts?: CustomResourceOptions): Volume

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        action: Optional[str] = None,
        completed_at: Optional[str] = None,
        created_at: Optional[str] = None,
        description: Optional[str] = None,
        image_id: Optional[str] = None,
        instance_id: Optional[str] = None,
        name: Optional[str] = None,
        progress: Optional[float] = None,
        region_name: Optional[str] = None,
        regions: Optional[Sequence[str]] = None,
        resource_id: Optional[str] = None,
        service_name: Optional[str] = None,
        size: Optional[float] = None,
        snapshot_id: Optional[str] = None,
        started_at: Optional[str] = None,
        status: Optional[str] = None,
        sub_operations: Optional[Sequence[_cloudproject.VolumeSubOperationArgs]] = None,
        type: Optional[str] = None,
        volume_id: Optional[str] = None) -> Volume

func GetVolume(ctx *Context, name string, id IDInput, state *VolumeState, opts ...ResourceOption) (*Volume, error)

public static Volume Get(string name, Input<string> id, VolumeState? state, CustomResourceOptions? opts = null)

public static Volume get(String name, Output<String> id, VolumeState state, CustomResourceOptions options)

resources:  _:    type: ovh:CloudProject:Volume    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:

Action string: The action of the operation
CompletedAt string: The completed date of the operation
CreatedAt string: The creation date of the operation
Description string: Volume description
ImageId string: Image ID
InstanceId string: Instance ID
Name string: Volume name
Progress double: Volume status
RegionName string: Region name
Regions List<string>: List of regions
ResourceId string: Id of the resource
ServiceName string: Service name
Size double: Volume size
SnapshotId string: Snapshot ID
StartedAt string: Datetime of the operation creation
Status string: Volume status
SubOperations List<VolumeSubOperation>: Sub-operations of the operation
Type string: Type of the volume
VolumeId string: Volume ID

Action string: The action of the operation
CompletedAt string: The completed date of the operation
CreatedAt string: The creation date of the operation
Description string: Volume description
ImageId string: Image ID
InstanceId string: Instance ID
Name string: Volume name
Progress float64: Volume status
RegionName string: Region name
Regions []string: List of regions
ResourceId string: Id of the resource
ServiceName string: Service name
Size float64: Volume size
SnapshotId string: Snapshot ID
StartedAt string: Datetime of the operation creation
Status string: Volume status
SubOperations []VolumeSubOperationArgs: Sub-operations of the operation
Type string: Type of the volume
VolumeId string: Volume ID

action String: The action of the operation
completedAt String: The completed date of the operation
createdAt String: The creation date of the operation
description String: Volume description
imageId String: Image ID
instanceId String: Instance ID
name String: Volume name
progress Double: Volume status
regionName String: Region name
regions List<String>: List of regions
resourceId String: Id of the resource
serviceName String: Service name
size Double: Volume size
snapshotId String: Snapshot ID
startedAt String: Datetime of the operation creation
status String: Volume status
subOperations List<VolumeSubOperation>: Sub-operations of the operation
type String: Type of the volume
volumeId String: Volume ID

action string: The action of the operation
completedAt string: The completed date of the operation
createdAt string: The creation date of the operation
description string: Volume description
imageId string: Image ID
instanceId string: Instance ID
name string: Volume name
progress number: Volume status
regionName string: Region name
regions string[]: List of regions
resourceId string: Id of the resource
serviceName string: Service name
size number: Volume size
snapshotId string: Snapshot ID
startedAt string: Datetime of the operation creation
status string: Volume status
subOperations VolumeSubOperation[]: Sub-operations of the operation
type string: Type of the volume
volumeId string: Volume ID

action str: The action of the operation
completed_at str: The completed date of the operation
created_at str: The creation date of the operation
description str: Volume description
image_id str: Image ID
instance_id str: Instance ID
name str: Volume name
progress float: Volume status
region_name str: Region name
regions Sequence[str]: List of regions
resource_id str: Id of the resource
service_name str: Service name
size float: Volume size
snapshot_id str: Snapshot ID
started_at str: Datetime of the operation creation
status str: Volume status
sub_operations Sequence[cloudproject.VolumeSubOperationArgs]: Sub-operations of the operation
type str: Type of the volume
volume_id str: Volume ID

action String: The action of the operation
completedAt String: The completed date of the operation
createdAt String: The creation date of the operation
description String: Volume description
imageId String: Image ID
instanceId String: Instance ID
name String: Volume name
progress Number: Volume status
regionName String: Region name
regions List<String>: List of regions
resourceId String: Id of the resource
serviceName String: Service name
size Number: Volume size
snapshotId String: Snapshot ID
startedAt String: Datetime of the operation creation
status String: Volume status
subOperations List<Property Map>: Sub-operations of the operation
type String: Type of the volume
volumeId String: Volume ID

Supporting Types

VolumeSubOperation, VolumeSubOperationArgs

ResourceId string: Affected resource of the sub-operation
ResourceType string: The started date of the sub-operation

ResourceId string: Affected resource of the sub-operation
ResourceType string: The started date of the sub-operation

resourceId String: Affected resource of the sub-operation
resourceType String: The started date of the sub-operation

resourceId string: Affected resource of the sub-operation
resourceType string: The started date of the sub-operation

resource_id str: Affected resource of the sub-operation
resource_type str: The started date of the sub-operation

resourceId String: Affected resource of the sub-operation
resourceType String: The started date of the sub-operation

Package Details

Repository: ovh ovh/pulumi-ovh
License: Apache-2.0
Notes: This Pulumi package is based on the ovh Terraform Provider.

OVHCloud v2.0.7 published on Wednesday, Mar 19, 2025 by OVHcloud

ovh/pulumi-ovh

ovh.CloudProject.Volume

On this page

On this page

Create Volume Resource

Constructor syntax

Parameters

Constructor example

Volume Resource Properties

Inputs

Outputs

Look up Existing Volume Resource

Supporting Types

VolumeSubOperation, VolumeSubOperationArgs

Package Details

On this page

On this page