1. Packages
  2. OVH
  3. API Docs
  4. CloudProject
  5. getStorage
OVHCloud v2.1.0 published on Friday, Mar 28, 2025 by OVHcloud

ovh.CloudProject.getStorage

Explore with Pulumi AI

OVHCloud v2.1.0 published on Friday, Mar 28, 2025 by OVHcloud

Get S3™* compatible storage container. * S3 is a trademark filed by Amazon Technologies,Inc. OVHcloud’s service is not sponsored by, endorsed by, or otherwise affiliated with Amazon Technologies,Inc.

Example Usage

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

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

storage = ovh.CloudProject.get_storage(name="my-storage-name",
    region_name="GRA",
    service_name="<public cloud project ID>")
Copy
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{
			Name:        "my-storage-name",
			RegionName:  "GRA",
			ServiceName: "<public cloud project ID>",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ovh = Pulumi.Ovh;

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

});
Copy
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()
            .name("my-storage-name")
            .regionName("GRA")
            .serviceName("<public cloud project ID>")
            .build());

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

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>
Copy
def get_storage(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(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]
Copy
func GetStorage(ctx *Context, args *GetStorageArgs, opts ...InvokeOption) (*GetStorageResult, error)
func GetStorageOutput(ctx *Context, args *GetStorageOutputArgs, opts ...InvokeOption) GetStorageResultOutput
Copy

> Note: This function is named GetStorage 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)
}
Copy
public static CompletableFuture<GetStorageResult> getStorage(GetStorageArgs args, InvokeOptions options)
public static Output<GetStorageResult> getStorage(GetStorageArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ovh:CloudProject/getStorage:getStorage
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
Name
RegionName This property is required. string
Region name
ServiceName This property is required. string
Service name
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 This property is required. string
Name
RegionName This property is required. string
Region name
ServiceName This property is required. string
Service name
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 This property is required. String
Name
regionName This property is required. String
Region name
serviceName This property is required. String
Service name
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 This property is required. string
Name
regionName This property is required. string
Region name
serviceName This property is required. string
Service name
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 This property is required. str
Name
region_name This property is required. str
Region name
service_name This property is required. str
Service name
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 This property is required. String
Name
regionName This property is required. String
Region name
serviceName This property is required. String
Service name
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
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
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
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
created_at str
The date and timestamp when the resource was created
encryption cloudproject.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[cloudproject.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 cloudproject.GetStorageReplication
Replication configuration
service_name str
Service name
tags Mapping[str, str]
Container tags
versioning cloudproject.GetStorageVersioning
Versioning configuration
virtual_host str
Container virtual host
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

Supporting Types

GetStorageEncryption

SseAlgorithm This property is required. string
Encryption algorithm
SseAlgorithm This property is required. string
Encryption algorithm
sseAlgorithm This property is required. String
Encryption algorithm
sseAlgorithm This property is required. string
Encryption algorithm
sse_algorithm This property is required. str
Encryption algorithm
sseAlgorithm This property is required. String
Encryption algorithm

GetStorageObject

Etag This property is required. string
ETag
IsDeleteMarker This property is required. bool
Whether this object is a delete marker
IsLatest This property is required. bool
Whether this is the latest version of the object
Key This property is required. string
Key
LastModified This property is required. string
Last modification date
Size This property is required. double
Size (bytes)
StorageClass This property is required. string
Storage class
VersionId This property is required. string
Version ID of the object
Etag This property is required. string
ETag
IsDeleteMarker This property is required. bool
Whether this object is a delete marker
IsLatest This property is required. bool
Whether this is the latest version of the object
Key This property is required. string
Key
LastModified This property is required. string
Last modification date
Size This property is required. float64
Size (bytes)
StorageClass This property is required. string
Storage class
VersionId This property is required. string
Version ID of the object
etag This property is required. String
ETag
isDeleteMarker This property is required. Boolean
Whether this object is a delete marker
isLatest This property is required. Boolean
Whether this is the latest version of the object
key This property is required. String
Key
lastModified This property is required. String
Last modification date
size This property is required. Double
Size (bytes)
storageClass This property is required. String
Storage class
versionId This property is required. String
Version ID of the object
etag This property is required. string
ETag
isDeleteMarker This property is required. boolean
Whether this object is a delete marker
isLatest This property is required. boolean
Whether this is the latest version of the object
key This property is required. string
Key
lastModified This property is required. string
Last modification date
size This property is required. number
Size (bytes)
storageClass This property is required. string
Storage class
versionId This property is required. string
Version ID of the object
etag This property is required. str
ETag
is_delete_marker This property is required. bool
Whether this object is a delete marker
is_latest This property is required. bool
Whether this is the latest version of the object
key This property is required. str
Key
last_modified This property is required. str
Last modification date
size This property is required. float
Size (bytes)
storage_class This property is required. str
Storage class
version_id This property is required. str
Version ID of the object
etag This property is required. String
ETag
isDeleteMarker This property is required. Boolean
Whether this object is a delete marker
isLatest This property is required. Boolean
Whether this is the latest version of the object
key This property is required. String
Key
lastModified This property is required. String
Last modification date
size This property is required. Number
Size (bytes)
storageClass This property is required. String
Storage class
versionId This property is required. String
Version ID of the object

GetStorageReplication

Rules This property is required. List<GetStorageReplicationRule>
Replication rules
Rules This property is required. []GetStorageReplicationRule
Replication rules
rules This property is required. List<GetStorageReplicationRule>
Replication rules
rules This property is required. GetStorageReplicationRule[]
Replication rules
rules This property is required. Sequence[cloudproject.GetStorageReplicationRule]
Replication rules
rules This property is required. List<Property Map>
Replication rules

GetStorageReplicationRule

DeleteMarkerReplication This property is required. string
Delete marker replication
Destination This property is required. GetStorageReplicationRuleDestination
Rule destination configuration
Filter This property is required. GetStorageReplicationRuleFilter
Rule filters
Id This property is required. string
Rule ID
Priority This property is required. double
Rule priority
Status This property is required. string
Rule status
DeleteMarkerReplication This property is required. string
Delete marker replication
Destination This property is required. GetStorageReplicationRuleDestination
Rule destination configuration
Filter This property is required. GetStorageReplicationRuleFilter
Rule filters
Id This property is required. string
Rule ID
Priority This property is required. float64
Rule priority
Status This property is required. string
Rule status
deleteMarkerReplication This property is required. String
Delete marker replication
destination This property is required. GetStorageReplicationRuleDestination
Rule destination configuration
filter This property is required. GetStorageReplicationRuleFilter
Rule filters
id This property is required. String
Rule ID
priority This property is required. Double
Rule priority
status This property is required. String
Rule status
deleteMarkerReplication This property is required. string
Delete marker replication
destination This property is required. GetStorageReplicationRuleDestination
Rule destination configuration
filter This property is required. GetStorageReplicationRuleFilter
Rule filters
id This property is required. string
Rule ID
priority This property is required. number
Rule priority
status This property is required. string
Rule status
delete_marker_replication This property is required. str
Delete marker replication
destination This property is required. cloudproject.GetStorageReplicationRuleDestination
Rule destination configuration
filter This property is required. cloudproject.GetStorageReplicationRuleFilter
Rule filters
id This property is required. str
Rule ID
priority This property is required. float
Rule priority
status This property is required. str
Rule status
deleteMarkerReplication This property is required. String
Delete marker replication
destination This property is required. Property Map
Rule destination configuration
filter This property is required. Property Map
Rule filters
id This property is required. String
Rule ID
priority This property is required. Number
Rule priority
status This property is required. String
Rule status

GetStorageReplicationRuleDestination

Name This property is required. string
Destination bucket name
Region This property is required. string
Destination region, can be null if destination bucket has been deleted
StorageClass This property is required. string
Destination storage class
Name This property is required. string
Destination bucket name
Region This property is required. string
Destination region, can be null if destination bucket has been deleted
StorageClass This property is required. string
Destination storage class
name This property is required. String
Destination bucket name
region This property is required. String
Destination region, can be null if destination bucket has been deleted
storageClass This property is required. String
Destination storage class
name This property is required. string
Destination bucket name
region This property is required. string
Destination region, can be null if destination bucket has been deleted
storageClass This property is required. string
Destination storage class
name This property is required. str
Destination bucket name
region This property is required. str
Destination region, can be null if destination bucket has been deleted
storage_class This property is required. str
Destination storage class
name This property is required. String
Destination bucket name
region This property is required. String
Destination region, can be null if destination bucket has been deleted
storageClass This property is required. String
Destination storage class

GetStorageReplicationRuleFilter

Prefix This property is required. string
Prefix filter
Tags This property is required. Dictionary<string, string>
Tags filter
Prefix This property is required. string
Prefix filter
Tags This property is required. map[string]string
Tags filter
prefix This property is required. String
Prefix filter
tags This property is required. Map<String,String>
Tags filter
prefix This property is required. string
Prefix filter
tags This property is required. {[key: string]: string}
Tags filter
prefix This property is required. str
Prefix filter
tags This property is required. Mapping[str, str]
Tags filter
prefix This property is required. String
Prefix filter
tags This property is required. Map<String>
Tags filter

GetStorageVersioning

Status This property is required. string
Versioning status
Status This property is required. string
Versioning status
status This property is required. String
Versioning status
status This property is required. string
Versioning status
status This property is required. str
Versioning status
status This property is required. 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.
OVHCloud v2.1.0 published on Friday, Mar 28, 2025 by OVHcloud