ovh.CloudProject.getStorage

OVHCloud v2.12.0, Mar 12 26

Viewing docs for OVHCloud v2.12.0
published on Thursday, Mar 12, 2026 by OVHcloud

Schema (JSON)

ovh/pulumi-ovh

Viewing docs for OVHCloud v2.12.0
published on Thursday, Mar 12, 2026 by OVHcloud

Schema (JSON)

ovh/pulumi-ovh

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as ovh from "@ovhcloud/pulumi-ovh";

const storage = ovh.CloudProject.getStorage({
    serviceName: "<public cloud project ID>",
    regionName: "GRA",
    name: "my-storage-name",
});

import pulumi
import pulumi_ovh as ovh

storage = ovh.CloudProject.get_storage(service_name="<public cloud project ID>",
    region_name="GRA",
    name="my-storage-name")

package main

import (
	"github.com/ovh/pulumi-ovh/sdk/v2/go/ovh/cloudproject"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudproject.GetStorage(ctx, &cloudproject.GetStorageArgs{
			ServiceName: "<public cloud project ID>",
			RegionName:  "GRA",
			Name:        "my-storage-name",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var storage = Ovh.CloudProject.GetStorage.Invoke(new()
    {
        ServiceName = "<public cloud project ID>",
        RegionName = "GRA",
        Name = "my-storage-name",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ovh.CloudProject.CloudProjectFunctions;
import com.pulumi.ovh.CloudProject.inputs.GetStorageArgs;
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) {
        final var storage = CloudProjectFunctions.getStorage(GetStorageArgs.builder()
            .serviceName("<public cloud project ID>")
            .regionName("GRA")
            .name("my-storage-name")
            .build());

    }
}

variables:
  storage:
    fn::invoke:
      function: ovh:CloudProject:getStorage
      arguments:
        serviceName: <public cloud project ID>
        regionName: GRA
        name: my-storage-name

Using getStorage

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getStorage(args: GetStorageArgs, opts?: InvokeOptions): Promise<GetStorageResult>
function getStorageOutput(args: GetStorageOutputArgs, opts?: InvokeOptions): Output<GetStorageResult>

def get_storage(hide_objects: Optional[bool] = None,
                limit: Optional[float] = None,
                marker: Optional[str] = None,
                name: Optional[str] = None,
                prefix: Optional[str] = None,
                region_name: Optional[str] = None,
                service_name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetStorageResult
def get_storage_output(hide_objects: Optional[pulumi.Input[bool]] = None,
                limit: Optional[pulumi.Input[float]] = None,
                marker: Optional[pulumi.Input[str]] = None,
                name: Optional[pulumi.Input[str]] = None,
                prefix: Optional[pulumi.Input[str]] = None,
                region_name: Optional[pulumi.Input[str]] = None,
                service_name: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetStorageResult]

func LookupStorage(ctx *Context, args *LookupStorageArgs, opts ...InvokeOption) (*LookupStorageResult, error)
func LookupStorageOutput(ctx *Context, args *LookupStorageOutputArgs, opts ...InvokeOption) LookupStorageResultOutput

> Note: This function is named LookupStorage in the Go SDK.

public static class GetStorage 
{
    public static Task<GetStorageResult> InvokeAsync(GetStorageArgs args, InvokeOptions? opts = null)
    public static Output<GetStorageResult> Invoke(GetStorageInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetStorageResult> getStorage(GetStorageArgs args, InvokeOptions options)
public static Output<GetStorageResult> getStorage(GetStorageArgs args, InvokeOptions options)

fn::invoke:
  function: ovh:CloudProject/getStorage:getStorage
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: Name
RegionName string: Region name
ServiceName string: Service name
HideObjects bool: If true, objects list will not be saved in state (useful for large buckets)
Limit double: Limit the number of objects returned (1000 maximum, defaults to 1000)
Marker string: Key to start with when listing objects
Prefix string: List objects whose key begins with this prefix

Name string: Name
RegionName string: Region name
ServiceName string: Service name
HideObjects bool: If true, objects list will not be saved in state (useful for large buckets)
Limit float64: Limit the number of objects returned (1000 maximum, defaults to 1000)
Marker string: Key to start with when listing objects
Prefix string: List objects whose key begins with this prefix

name String: Name
regionName String: Region name
serviceName String: Service name
hideObjects Boolean: If true, objects list will not be saved in state (useful for large buckets)
limit Double: Limit the number of objects returned (1000 maximum, defaults to 1000)
marker String: Key to start with when listing objects
prefix String: List objects whose key begins with this prefix

name string: Name
regionName string: Region name
serviceName string: Service name
hideObjects boolean: If true, objects list will not be saved in state (useful for large buckets)
limit number: Limit the number of objects returned (1000 maximum, defaults to 1000)
marker string: Key to start with when listing objects
prefix string: List objects whose key begins with this prefix

name str: Name
region_name str: Region name
service_name str: Service name
hide_objects bool: If true, objects list will not be saved in state (useful for large buckets)
limit float: Limit the number of objects returned (1000 maximum, defaults to 1000)
marker str: Key to start with when listing objects
prefix str: List objects whose key begins with this prefix

name String: Name
regionName String: Region name
serviceName String: Service name
hideObjects Boolean: If true, objects list will not be saved in state (useful for large buckets)
limit Number: Limit the number of objects returned (1000 maximum, defaults to 1000)
marker String: Key to start with when listing objects
prefix String: List objects whose key begins with this prefix

getStorage Result

The following output properties are available:

CreatedAt string: The date and timestamp when the resource was created
Encryption GetStorageEncryption: Encryption configuration
Id string: The provider-assigned unique ID for this managed resource.
Limit double: Limit the number of objects returned (1000 maximum, defaults to 1000)
Marker string: Key to start with when listing objects
Name string: Name
Objects List<GetStorageObject>: Container objects
ObjectsCount double: Container total objects count
ObjectsSize double: Container total objects size (bytes)
OwnerId double: Container owner user ID
Prefix string: List objects whose key begins with this prefix
Region string: Container region
RegionName string: Region name
Replication GetStorageReplication: Replication configuration
ServiceName string: Service name
Tags Dictionary<string, string>: Container tags
Versioning GetStorageVersioning: Versioning configuration
VirtualHost string: Container virtual host
HideObjects bool: If true, objects list will not be saved in state (useful for large buckets)

CreatedAt string: The date and timestamp when the resource was created
Encryption GetStorageEncryption: Encryption configuration
Id string: The provider-assigned unique ID for this managed resource.
Limit float64: Limit the number of objects returned (1000 maximum, defaults to 1000)
Marker string: Key to start with when listing objects
Name string: Name
Objects []GetStorageObject: Container objects
ObjectsCount float64: Container total objects count
ObjectsSize float64: Container total objects size (bytes)
OwnerId float64: Container owner user ID
Prefix string: List objects whose key begins with this prefix
Region string: Container region
RegionName string: Region name
Replication GetStorageReplication: Replication configuration
ServiceName string: Service name
Tags map[string]string: Container tags
Versioning GetStorageVersioning: Versioning configuration
VirtualHost string: Container virtual host
HideObjects bool: If true, objects list will not be saved in state (useful for large buckets)

createdAt String: The date and timestamp when the resource was created
encryption GetStorageEncryption: Encryption configuration
id String: The provider-assigned unique ID for this managed resource.
limit Double: Limit the number of objects returned (1000 maximum, defaults to 1000)
marker String: Key to start with when listing objects
name String: Name
objects List<GetStorageObject>: Container objects
objectsCount Double: Container total objects count
objectsSize Double: Container total objects size (bytes)
ownerId Double: Container owner user ID
prefix String: List objects whose key begins with this prefix
region String: Container region
regionName String: Region name
replication GetStorageReplication: Replication configuration
serviceName String: Service name
tags Map<String,String>: Container tags
versioning GetStorageVersioning: Versioning configuration
virtualHost String: Container virtual host
hideObjects Boolean: If true, objects list will not be saved in state (useful for large buckets)

createdAt string: The date and timestamp when the resource was created
encryption GetStorageEncryption: Encryption configuration
id string: The provider-assigned unique ID for this managed resource.
limit number: Limit the number of objects returned (1000 maximum, defaults to 1000)
marker string: Key to start with when listing objects
name string: Name
objects GetStorageObject[]: Container objects
objectsCount number: Container total objects count
objectsSize number: Container total objects size (bytes)
ownerId number: Container owner user ID
prefix string: List objects whose key begins with this prefix
region string: Container region
regionName string: Region name
replication GetStorageReplication: Replication configuration
serviceName string: Service name
tags {[key: string]: string}: Container tags
versioning GetStorageVersioning: Versioning configuration
virtualHost string: Container virtual host
hideObjects boolean: If true, objects list will not be saved in state (useful for large buckets)

created_at str: The date and timestamp when the resource was created
encryption GetStorageEncryption: Encryption configuration
id str: The provider-assigned unique ID for this managed resource.
limit float: Limit the number of objects returned (1000 maximum, defaults to 1000)
marker str: Key to start with when listing objects
name str: Name
objects Sequence[GetStorageObject]: Container objects
objects_count float: Container total objects count
objects_size float: Container total objects size (bytes)
owner_id float: Container owner user ID
prefix str: List objects whose key begins with this prefix
region str: Container region
region_name str: Region name
replication GetStorageReplication: Replication configuration
service_name str: Service name
tags Mapping[str, str]: Container tags
versioning GetStorageVersioning: Versioning configuration
virtual_host str: Container virtual host
hide_objects bool: If true, objects list will not be saved in state (useful for large buckets)

createdAt String: The date and timestamp when the resource was created
encryption Property Map: Encryption configuration
id String: The provider-assigned unique ID for this managed resource.
limit Number: Limit the number of objects returned (1000 maximum, defaults to 1000)
marker String: Key to start with when listing objects
name String: Name
objects List<Property Map>: Container objects
objectsCount Number: Container total objects count
objectsSize Number: Container total objects size (bytes)
ownerId Number: Container owner user ID
prefix String: List objects whose key begins with this prefix
region String: Container region
regionName String: Region name
replication Property Map: Replication configuration
serviceName String: Service name
tags Map<String>: Container tags
versioning Property Map: Versioning configuration
virtualHost String: Container virtual host
hideObjects Boolean: If true, objects list will not be saved in state (useful for large buckets)

Supporting Types

GetStorageEncryption

SseAlgorithm string: Encryption algorithm

SseAlgorithm string: Encryption algorithm

sseAlgorithm String: Encryption algorithm

sseAlgorithm string: Encryption algorithm

sse_algorithm str: Encryption algorithm

sseAlgorithm String: Encryption algorithm

GetStorageObject

Etag string: ETag
IsDeleteMarker bool: Whether this object is a delete marker
IsLatest bool: Whether this is the latest version of the object
Key string: Key
LastModified string: Last modification date
Size double: Size (bytes)
StorageClass string: Storage class
VersionId string: Version ID of the object

Etag string: ETag
IsDeleteMarker bool: Whether this object is a delete marker
IsLatest bool: Whether this is the latest version of the object
Key string: Key
LastModified string: Last modification date
Size float64: Size (bytes)
StorageClass string: Storage class
VersionId string: Version ID of the object

etag String: ETag
isDeleteMarker Boolean: Whether this object is a delete marker
isLatest Boolean: Whether this is the latest version of the object
key String: Key
lastModified String: Last modification date
size Double: Size (bytes)
storageClass String: Storage class
versionId String: Version ID of the object

etag string: ETag
isDeleteMarker boolean: Whether this object is a delete marker
isLatest boolean: Whether this is the latest version of the object
key string: Key
lastModified string: Last modification date
size number: Size (bytes)
storageClass string: Storage class
versionId string: Version ID of the object

etag str: ETag
is_delete_marker bool: Whether this object is a delete marker
is_latest bool: Whether this is the latest version of the object
key str: Key
last_modified str: Last modification date
size float: Size (bytes)
storage_class str: Storage class
version_id str: Version ID of the object

etag String: ETag
isDeleteMarker Boolean: Whether this object is a delete marker
isLatest Boolean: Whether this is the latest version of the object
key String: Key
lastModified String: Last modification date
size Number: Size (bytes)
storageClass String: Storage class
versionId String: Version ID of the object

GetStorageReplication

Rules List<GetStorageReplicationRule>: Replication rules

Rules []GetStorageReplicationRule: Replication rules

rules List<GetStorageReplicationRule>: Replication rules

rules GetStorageReplicationRule[]: Replication rules

rules Sequence[GetStorageReplicationRule]: Replication rules

rules List<Property Map>: Replication rules

GetStorageReplicationRule

DeleteMarkerReplication string: Delete marker replication
Destination GetStorageReplicationRuleDestination: Rule destination configuration
Filter GetStorageReplicationRuleFilter: Rule filters
Id string: Rule ID
Priority double: Rule priority
Status string: Rule status

DeleteMarkerReplication string: Delete marker replication
Destination GetStorageReplicationRuleDestination: Rule destination configuration
Filter GetStorageReplicationRuleFilter: Rule filters
Id string: Rule ID
Priority float64: Rule priority
Status string: Rule status

deleteMarkerReplication String: Delete marker replication
destination GetStorageReplicationRuleDestination: Rule destination configuration
filter GetStorageReplicationRuleFilter: Rule filters
id String: Rule ID
priority Double: Rule priority
status String: Rule status

deleteMarkerReplication string: Delete marker replication
destination GetStorageReplicationRuleDestination: Rule destination configuration
filter GetStorageReplicationRuleFilter: Rule filters
id string: Rule ID
priority number: Rule priority
status string: Rule status

delete_marker_replication str: Delete marker replication
destination GetStorageReplicationRuleDestination: Rule destination configuration
filter GetStorageReplicationRuleFilter: Rule filters
id str: Rule ID
priority float: Rule priority
status str: Rule status

deleteMarkerReplication String: Delete marker replication
destination Property Map: Rule destination configuration
filter Property Map: Rule filters
id String: Rule ID
priority Number: Rule priority
status String: Rule status

GetStorageReplicationRuleDestination

Name string: Destination bucket name
Region string: Destination region, can be null if destination bucket has been deleted
RemoveOnMainBucketDeletion bool
StorageClass string: Destination storage class

Name string: Destination bucket name
Region string: Destination region, can be null if destination bucket has been deleted
RemoveOnMainBucketDeletion bool
StorageClass string: Destination storage class

name String: Destination bucket name
region String: Destination region, can be null if destination bucket has been deleted
removeOnMainBucketDeletion Boolean
storageClass String: Destination storage class

name string: Destination bucket name
region string: Destination region, can be null if destination bucket has been deleted
removeOnMainBucketDeletion boolean
storageClass string: Destination storage class

name str: Destination bucket name
region str: Destination region, can be null if destination bucket has been deleted
remove_on_main_bucket_deletion bool
storage_class str: Destination storage class

name String: Destination bucket name
region String: Destination region, can be null if destination bucket has been deleted
removeOnMainBucketDeletion Boolean
storageClass String: Destination storage class

GetStorageReplicationRuleFilter

Prefix string: Prefix filter
Tags Dictionary<string, string>: Tags filter

Prefix string: Prefix filter
Tags map[string]string: Tags filter

prefix String: Prefix filter
tags Map<String,String>: Tags filter

prefix string: Prefix filter
tags {[key: string]: string}: Tags filter

prefix str: Prefix filter
tags Mapping[str, str]: Tags filter

prefix String: Prefix filter
tags Map<String>: Tags filter

GetStorageVersioning

Status string: Versioning status

Status string: Versioning status

status String: Versioning status

status string: Versioning status

status str: Versioning status

status String: Versioning status

Package Details

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

Viewing docs for OVHCloud v2.12.0
published on Thursday, Mar 12, 2026 by OVHcloud

Schema (JSON)

ovh/pulumi-ovh

ovh.CloudProject.getStorage

On this page

On this page

Example Usage

Using getStorage

getStorage Result

Supporting Types

GetStorageEncryption

GetStorageObject

GetStorageReplication

GetStorageReplicationRule

GetStorageReplicationRuleDestination

GetStorageReplicationRuleFilter

GetStorageVersioning

Package Details

On this page

On this page