Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. OVH
  4. API Docs
  5. getCloudStorageObjectBuckets
Viewing docs for OVHCloud v2.22.0
published on Monday, Oct 5, 2026 by OVHcloud
Schema (JSON)
ovh/pulumi-ovh

ovh.getCloudStorageObjectBuckets

ovh logo
Viewing docs for OVHCloud v2.22.0
published on Monday, Oct 5, 2026 by OVHcloud
Schema (JSON)
ovh/pulumi-ovh

    List the S3™ compatible object storage buckets in a public cloud project.

    NOTE 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.

    Using getCloudStorageObjectBuckets

    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 getCloudStorageObjectBuckets(args: GetCloudStorageObjectBucketsArgs, opts?: InvokeOptions): Promise<GetCloudStorageObjectBucketsResult>
function getCloudStorageObjectBucketsOutput(args: GetCloudStorageObjectBucketsOutputArgs, opts?: InvokeOutputOptions): Output<GetCloudStorageObjectBucketsResult>
    def get_cloud_storage_object_buckets(region: Optional[str] = None,
                                     service_name: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetCloudStorageObjectBucketsResult
def get_cloud_storage_object_buckets_output(region: pulumi.Input[Optional[str]] = None,
                                     service_name: pulumi.Input[Optional[str]] = None,
                                     opts: Optional[InvokeOutputOptions] = None) -> Output[GetCloudStorageObjectBucketsResult]
    func GetCloudStorageObjectBuckets(ctx *Context, args *GetCloudStorageObjectBucketsArgs, opts ...InvokeOption) (*GetCloudStorageObjectBucketsResult, error)
func GetCloudStorageObjectBucketsOutput(ctx *Context, args *GetCloudStorageObjectBucketsOutputArgs, opts ...InvokeOption) GetCloudStorageObjectBucketsResultOutput

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

    public static class GetCloudStorageObjectBuckets 
{
    public static Task<GetCloudStorageObjectBucketsResult> InvokeAsync(GetCloudStorageObjectBucketsArgs args, InvokeOptions? opts = null)
    public static Output<GetCloudStorageObjectBucketsResult> Invoke(GetCloudStorageObjectBucketsInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetCloudStorageObjectBucketsResult> Invoke(GetCloudStorageObjectBucketsInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetCloudStorageObjectBucketsResult> getCloudStorageObjectBuckets(GetCloudStorageObjectBucketsArgs args, InvokeOptions options)
public static Output<GetCloudStorageObjectBucketsResult> getCloudStorageObjectBuckets(GetCloudStorageObjectBucketsArgs args, InvokeOptions options)
public static Output<GetCloudStorageObjectBucketsResult> getCloudStorageObjectBuckets(GetCloudStorageObjectBucketsArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: ovh:index/getCloudStorageObjectBuckets:getCloudStorageObjectBuckets
  arguments:
    # arguments dictionary
    data "ovh_get_cloud_storage_object_buckets" "name" {
    # arguments
}

    The following arguments are supported:

    ServiceName string
    The id of the public cloud project.
    Region string
    If set, only buckets located in this region are returned.
    ServiceName string
    The id of the public cloud project.
    Region string
    If set, only buckets located in this region are returned.
    service_name string
    The id of the public cloud project.
    region string
    If set, only buckets located in this region are returned.
    serviceName String
    The id of the public cloud project.
    region String
    If set, only buckets located in this region are returned.
    serviceName string
    The id of the public cloud project.
    region string
    If set, only buckets located in this region are returned.
    service_name str
    The id of the public cloud project.
    region str
    If set, only buckets located in this region are returned.
    serviceName String
    The id of the public cloud project.
    region String
    If set, only buckets located in this region are returned.

    getCloudStorageObjectBuckets Result

    The following output properties are available:

    Buckets List<GetCloudStorageObjectBucketsBucket>
    List of buckets:
    Id string
    The provider-assigned unique ID for this managed resource.
    ServiceName string
    Region string
    Region identifier.
    Buckets []GetCloudStorageObjectBucketsBucket
    List of buckets:
    Id string
    The provider-assigned unique ID for this managed resource.
    ServiceName string
    Region string
    Region identifier.
    buckets list(object)
    List of buckets:
    id string
    The provider-assigned unique ID for this managed resource.
    service_name string
    region string
    Region identifier.
    buckets List<GetCloudStorageObjectBucketsBucket>
    List of buckets:
    id String
    The provider-assigned unique ID for this managed resource.
    serviceName String
    region String
    Region identifier.
    buckets GetCloudStorageObjectBucketsBucket[]
    List of buckets:
    id string
    The provider-assigned unique ID for this managed resource.
    serviceName string
    region string
    Region identifier.
    buckets Sequence[GetCloudStorageObjectBucketsBucket]
    List of buckets:
    id str
    The provider-assigned unique ID for this managed resource.
    service_name str
    region str
    Region identifier.
    buckets List<Property Map>
    List of buckets:
    id String
    The provider-assigned unique ID for this managed resource.
    serviceName String
    region String
    Region identifier.

    Supporting Types

    GetCloudStorageObjectBucketsBucket

    Checksum string
    Computed hash representing the current target specification value.
    CreatedAt string
    Creation date of the bucket.
    CurrentState GetCloudStorageObjectBucketsBucketCurrentState
    Current observed state of the bucket:
    Encryption GetCloudStorageObjectBucketsBucketEncryption
    Current encryption configuration:
    Id string
    Bucket identifier.
    Location GetCloudStorageObjectBucketsBucketLocation
    Geographic region where the bucket is located:
    Name string
    Bucket name.
    ObjectLock GetCloudStorageObjectBucketsBucketObjectLock
    Current object lock configuration:
    OwnerUserId string
    Owner user identifier.
    ResourceStatus string
    Bucket readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING).
    Tags Dictionary<string, string>
    Current metadata tags.
    UpdatedAt string
    Last update date of the bucket.
    Versioning GetCloudStorageObjectBucketsBucketVersioning
    Current versioning configuration:
    Checksum string
    Computed hash representing the current target specification value.
    CreatedAt string
    Creation date of the bucket.
    CurrentState GetCloudStorageObjectBucketsBucketCurrentState
    Current observed state of the bucket:
    Encryption GetCloudStorageObjectBucketsBucketEncryption
    Current encryption configuration:
    Id string
    Bucket identifier.
    Location GetCloudStorageObjectBucketsBucketLocation
    Geographic region where the bucket is located:
    Name string
    Bucket name.
    ObjectLock GetCloudStorageObjectBucketsBucketObjectLock
    Current object lock configuration:
    OwnerUserId string
    Owner user identifier.
    ResourceStatus string
    Bucket readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING).
    Tags map[string]string
    Current metadata tags.
    UpdatedAt string
    Last update date of the bucket.
    Versioning GetCloudStorageObjectBucketsBucketVersioning
    Current versioning configuration:
    checksum string
    Computed hash representing the current target specification value.
    created_at string
    Creation date of the bucket.
    current_state object
    Current observed state of the bucket:
    encryption object
    Current encryption configuration:
    id string
    Bucket identifier.
    location object
    Geographic region where the bucket is located:
    name string
    Bucket name.
    object_lock object
    Current object lock configuration:
    owner_user_id string
    Owner user identifier.
    resource_status string
    Bucket readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING).
    tags map(string)
    Current metadata tags.
    updated_at string
    Last update date of the bucket.
    versioning object
    Current versioning configuration:
    checksum String
    Computed hash representing the current target specification value.
    createdAt String
    Creation date of the bucket.
    currentState GetCloudStorageObjectBucketsBucketCurrentState
    Current observed state of the bucket:
    encryption GetCloudStorageObjectBucketsBucketEncryption
    Current encryption configuration:
    id String
    Bucket identifier.
    location GetCloudStorageObjectBucketsBucketLocation
    Geographic region where the bucket is located:
    name String
    Bucket name.
    objectLock GetCloudStorageObjectBucketsBucketObjectLock
    Current object lock configuration:
    ownerUserId String
    Owner user identifier.
    resourceStatus String
    Bucket readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING).
    tags Map<String,String>
    Current metadata tags.
    updatedAt String
    Last update date of the bucket.
    versioning GetCloudStorageObjectBucketsBucketVersioning
    Current versioning configuration:
    checksum string
    Computed hash representing the current target specification value.
    createdAt string
    Creation date of the bucket.
    currentState GetCloudStorageObjectBucketsBucketCurrentState
    Current observed state of the bucket:
    encryption GetCloudStorageObjectBucketsBucketEncryption
    Current encryption configuration:
    id string
    Bucket identifier.
    location GetCloudStorageObjectBucketsBucketLocation
    Geographic region where the bucket is located:
    name string
    Bucket name.
    objectLock GetCloudStorageObjectBucketsBucketObjectLock
    Current object lock configuration:
    ownerUserId string
    Owner user identifier.
    resourceStatus string
    Bucket readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING).
    tags {[key: string]: string}
    Current metadata tags.
    updatedAt string
    Last update date of the bucket.
    versioning GetCloudStorageObjectBucketsBucketVersioning
    Current versioning configuration:
    checksum str
    Computed hash representing the current target specification value.
    created_at str
    Creation date of the bucket.
    current_state GetCloudStorageObjectBucketsBucketCurrentState
    Current observed state of the bucket:
    encryption GetCloudStorageObjectBucketsBucketEncryption
    Current encryption configuration:
    id str
    Bucket identifier.
    location GetCloudStorageObjectBucketsBucketLocation
    Geographic region where the bucket is located:
    name str
    Bucket name.
    object_lock GetCloudStorageObjectBucketsBucketObjectLock
    Current object lock configuration:
    owner_user_id str
    Owner user identifier.
    resource_status str
    Bucket readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING).
    tags Mapping[str, str]
    Current metadata tags.
    updated_at str
    Last update date of the bucket.
    versioning GetCloudStorageObjectBucketsBucketVersioning
    Current versioning configuration:
    checksum String
    Computed hash representing the current target specification value.
    createdAt String
    Creation date of the bucket.
    currentState Property Map
    Current observed state of the bucket:
    encryption Property Map
    Current encryption configuration:
    id String
    Bucket identifier.
    location Property Map
    Geographic region where the bucket is located:
    name String
    Bucket name.
    objectLock Property Map
    Current object lock configuration:
    ownerUserId String
    Owner user identifier.
    resourceStatus String
    Bucket readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING).
    tags Map<String>
    Current metadata tags.
    updatedAt String
    Last update date of the bucket.
    versioning Property Map
    Current versioning configuration:

    GetCloudStorageObjectBucketsBucketCurrentState

    Encryption GetCloudStorageObjectBucketsBucketCurrentStateEncryption
    Current encryption configuration:
    Location GetCloudStorageObjectBucketsBucketCurrentStateLocation
    Geographic region where the bucket is located:
    Name string
    Bucket name.
    ObjectLock GetCloudStorageObjectBucketsBucketCurrentStateObjectLock
    Current object lock configuration:
    ObjectsCount int
    Bucket total objects count. Only returned on a single bucket read, null here.
    ObjectsSize int
    Bucket total objects size in bytes. Only returned on a single bucket read, null here.
    Tags Dictionary<string, string>
    Current metadata tags.
    Versioning GetCloudStorageObjectBucketsBucketCurrentStateVersioning
    Current versioning configuration:
    VirtualHost string
    Bucket virtual host. Only returned on a single bucket read, null here.
    Encryption GetCloudStorageObjectBucketsBucketCurrentStateEncryption
    Current encryption configuration:
    Location GetCloudStorageObjectBucketsBucketCurrentStateLocation
    Geographic region where the bucket is located:
    Name string
    Bucket name.
    ObjectLock GetCloudStorageObjectBucketsBucketCurrentStateObjectLock
    Current object lock configuration:
    ObjectsCount int
    Bucket total objects count. Only returned on a single bucket read, null here.
    ObjectsSize int
    Bucket total objects size in bytes. Only returned on a single bucket read, null here.
    Tags map[string]string
    Current metadata tags.
    Versioning GetCloudStorageObjectBucketsBucketCurrentStateVersioning
    Current versioning configuration:
    VirtualHost string
    Bucket virtual host. Only returned on a single bucket read, null here.
    encryption object
    Current encryption configuration:
    location object
    Geographic region where the bucket is located:
    name string
    Bucket name.
    object_lock object
    Current object lock configuration:
    objects_count number
    Bucket total objects count. Only returned on a single bucket read, null here.
    objects_size number
    Bucket total objects size in bytes. Only returned on a single bucket read, null here.
    tags map(string)
    Current metadata tags.
    versioning object
    Current versioning configuration:
    virtual_host string
    Bucket virtual host. Only returned on a single bucket read, null here.
    encryption GetCloudStorageObjectBucketsBucketCurrentStateEncryption
    Current encryption configuration:
    location GetCloudStorageObjectBucketsBucketCurrentStateLocation
    Geographic region where the bucket is located:
    name String
    Bucket name.
    objectLock GetCloudStorageObjectBucketsBucketCurrentStateObjectLock
    Current object lock configuration:
    objectsCount Integer
    Bucket total objects count. Only returned on a single bucket read, null here.
    objectsSize Integer
    Bucket total objects size in bytes. Only returned on a single bucket read, null here.
    tags Map<String,String>
    Current metadata tags.
    versioning GetCloudStorageObjectBucketsBucketCurrentStateVersioning
    Current versioning configuration:
    virtualHost String
    Bucket virtual host. Only returned on a single bucket read, null here.
    encryption GetCloudStorageObjectBucketsBucketCurrentStateEncryption
    Current encryption configuration:
    location GetCloudStorageObjectBucketsBucketCurrentStateLocation
    Geographic region where the bucket is located:
    name string
    Bucket name.
    objectLock GetCloudStorageObjectBucketsBucketCurrentStateObjectLock
    Current object lock configuration:
    objectsCount number
    Bucket total objects count. Only returned on a single bucket read, null here.
    objectsSize number
    Bucket total objects size in bytes. Only returned on a single bucket read, null here.
    tags {[key: string]: string}
    Current metadata tags.
    versioning GetCloudStorageObjectBucketsBucketCurrentStateVersioning
    Current versioning configuration:
    virtualHost string
    Bucket virtual host. Only returned on a single bucket read, null here.
    encryption GetCloudStorageObjectBucketsBucketCurrentStateEncryption
    Current encryption configuration:
    location GetCloudStorageObjectBucketsBucketCurrentStateLocation
    Geographic region where the bucket is located:
    name str
    Bucket name.
    object_lock GetCloudStorageObjectBucketsBucketCurrentStateObjectLock
    Current object lock configuration:
    objects_count int
    Bucket total objects count. Only returned on a single bucket read, null here.
    objects_size int
    Bucket total objects size in bytes. Only returned on a single bucket read, null here.
    tags Mapping[str, str]
    Current metadata tags.
    versioning GetCloudStorageObjectBucketsBucketCurrentStateVersioning
    Current versioning configuration:
    virtual_host str
    Bucket virtual host. Only returned on a single bucket read, null here.
    encryption Property Map
    Current encryption configuration:
    location Property Map
    Geographic region where the bucket is located:
    name String
    Bucket name.
    objectLock Property Map
    Current object lock configuration:
    objectsCount Number
    Bucket total objects count. Only returned on a single bucket read, null here.
    objectsSize Number
    Bucket total objects size in bytes. Only returned on a single bucket read, null here.
    tags Map<String>
    Current metadata tags.
    versioning Property Map
    Current versioning configuration:
    virtualHost String
    Bucket virtual host. Only returned on a single bucket read, null here.

    GetCloudStorageObjectBucketsBucketCurrentStateEncryption

    Algorithm string
    Encryption algorithm.
    Algorithm string
    Encryption algorithm.
    algorithm string
    Encryption algorithm.
    algorithm String
    Encryption algorithm.
    algorithm string
    Encryption algorithm.
    algorithm str
    Encryption algorithm.
    algorithm String
    Encryption algorithm.

    GetCloudStorageObjectBucketsBucketCurrentStateLocation

    Region string
    If set, only buckets located in this region are returned.
    Region string
    If set, only buckets located in this region are returned.
    region string
    If set, only buckets located in this region are returned.
    region String
    If set, only buckets located in this region are returned.
    region string
    If set, only buckets located in this region are returned.
    region str
    If set, only buckets located in this region are returned.
    region String
    If set, only buckets located in this region are returned.

    GetCloudStorageObjectBucketsBucketCurrentStateObjectLock

    Mode string
    Object lock retention mode.
    RetentionDays int
    Number of days to retain objects.
    RetentionYears int
    Number of years to retain objects.
    Mode string
    Object lock retention mode.
    RetentionDays int
    Number of days to retain objects.
    RetentionYears int
    Number of years to retain objects.
    mode string
    Object lock retention mode.
    retention_days number
    Number of days to retain objects.
    retention_years number
    Number of years to retain objects.
    mode String
    Object lock retention mode.
    retentionDays Integer
    Number of days to retain objects.
    retentionYears Integer
    Number of years to retain objects.
    mode string
    Object lock retention mode.
    retentionDays number
    Number of days to retain objects.
    retentionYears number
    Number of years to retain objects.
    mode str
    Object lock retention mode.
    retention_days int
    Number of days to retain objects.
    retention_years int
    Number of years to retain objects.
    mode String
    Object lock retention mode.
    retentionDays Number
    Number of days to retain objects.
    retentionYears Number
    Number of years to retain objects.

    GetCloudStorageObjectBucketsBucketCurrentStateVersioning

    Status string
    Versioning status.
    Status string
    Versioning status.
    status string
    Versioning status.
    status String
    Versioning status.
    status string
    Versioning status.
    status str
    Versioning status.
    status String
    Versioning status.

    GetCloudStorageObjectBucketsBucketEncryption

    Algorithm string
    Encryption algorithm.
    Algorithm string
    Encryption algorithm.
    algorithm string
    Encryption algorithm.
    algorithm String
    Encryption algorithm.
    algorithm string
    Encryption algorithm.
    algorithm str
    Encryption algorithm.
    algorithm String
    Encryption algorithm.

    GetCloudStorageObjectBucketsBucketLocation

    Region string
    If set, only buckets located in this region are returned.
    Region string
    If set, only buckets located in this region are returned.
    region string
    If set, only buckets located in this region are returned.
    region String
    If set, only buckets located in this region are returned.
    region string
    If set, only buckets located in this region are returned.
    region str
    If set, only buckets located in this region are returned.
    region String
    If set, only buckets located in this region are returned.

    GetCloudStorageObjectBucketsBucketObjectLock

    Mode string
    Object lock retention mode.
    RetentionDays int
    Number of days to retain objects.
    RetentionYears int
    Number of years to retain objects.
    Mode string
    Object lock retention mode.
    RetentionDays int
    Number of days to retain objects.
    RetentionYears int
    Number of years to retain objects.
    mode string
    Object lock retention mode.
    retention_days number
    Number of days to retain objects.
    retention_years number
    Number of years to retain objects.
    mode String
    Object lock retention mode.
    retentionDays Integer
    Number of days to retain objects.
    retentionYears Integer
    Number of years to retain objects.
    mode string
    Object lock retention mode.
    retentionDays number
    Number of days to retain objects.
    retentionYears number
    Number of years to retain objects.
    mode str
    Object lock retention mode.
    retention_days int
    Number of days to retain objects.
    retention_years int
    Number of years to retain objects.
    mode String
    Object lock retention mode.
    retentionDays Number
    Number of days to retain objects.
    retentionYears Number
    Number of years to retain objects.

    GetCloudStorageObjectBucketsBucketVersioning

    Status string
    Versioning status.
    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.
    ovh logo
    Viewing docs for OVHCloud v2.22.0
    published on Monday, Oct 5, 2026 by OVHcloud
    Schema (JSON)
    ovh/pulumi-ovh

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial