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

ovh.getCloudStorageObjectBucket

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

    Get an S3™ compatible object storage bucket 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 getCloudStorageObjectBucket

    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 getCloudStorageObjectBucket(args: GetCloudStorageObjectBucketArgs, opts?: InvokeOptions): Promise<GetCloudStorageObjectBucketResult>
function getCloudStorageObjectBucketOutput(args: GetCloudStorageObjectBucketOutputArgs, opts?: InvokeOutputOptions): Output<GetCloudStorageObjectBucketResult>
    def get_cloud_storage_object_bucket(id: Optional[str] = None,
                                    service_name: Optional[str] = None,
                                    opts: Optional[InvokeOptions] = None) -> GetCloudStorageObjectBucketResult
def get_cloud_storage_object_bucket_output(id: pulumi.Input[Optional[str]] = None,
                                    service_name: pulumi.Input[Optional[str]] = None,
                                    opts: Optional[InvokeOutputOptions] = None) -> Output[GetCloudStorageObjectBucketResult]
    func LookupCloudStorageObjectBucket(ctx *Context, args *LookupCloudStorageObjectBucketArgs, opts ...InvokeOption) (*LookupCloudStorageObjectBucketResult, error)
func LookupCloudStorageObjectBucketOutput(ctx *Context, args *LookupCloudStorageObjectBucketOutputArgs, opts ...InvokeOption) LookupCloudStorageObjectBucketResultOutput

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

    public static class GetCloudStorageObjectBucket 
{
    public static Task<GetCloudStorageObjectBucketResult> InvokeAsync(GetCloudStorageObjectBucketArgs args, InvokeOptions? opts = null)
    public static Output<GetCloudStorageObjectBucketResult> Invoke(GetCloudStorageObjectBucketInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetCloudStorageObjectBucketResult> Invoke(GetCloudStorageObjectBucketInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetCloudStorageObjectBucketResult> getCloudStorageObjectBucket(GetCloudStorageObjectBucketArgs args, InvokeOptions options)
public static Output<GetCloudStorageObjectBucketResult> getCloudStorageObjectBucket(GetCloudStorageObjectBucketArgs args, InvokeOptions options)
public static Output<GetCloudStorageObjectBucketResult> getCloudStorageObjectBucket(GetCloudStorageObjectBucketArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: ovh:index/getCloudStorageObjectBucket:getCloudStorageObjectBucket
  arguments:
    # arguments dictionary
    data "ovh_get_cloud_storage_object_bucket" "name" {
    # arguments
}

    The following arguments are supported:

    Id string
    Bucket identifier, in the <REGION>_<name> form (e.g. GRA_my-data-bucket).
    ServiceName string
    The id of the public cloud project.
    Id string
    Bucket identifier, in the <REGION>_<name> form (e.g. GRA_my-data-bucket).
    ServiceName string
    The id of the public cloud project.
    id string
    Bucket identifier, in the <REGION>_<name> form (e.g. GRA_my-data-bucket).
    service_name string
    The id of the public cloud project.
    id String
    Bucket identifier, in the <REGION>_<name> form (e.g. GRA_my-data-bucket).
    serviceName String
    The id of the public cloud project.
    id string
    Bucket identifier, in the <REGION>_<name> form (e.g. GRA_my-data-bucket).
    serviceName string
    The id of the public cloud project.
    id str
    Bucket identifier, in the <REGION>_<name> form (e.g. GRA_my-data-bucket).
    service_name str
    The id of the public cloud project.
    id String
    Bucket identifier, in the <REGION>_<name> form (e.g. GRA_my-data-bucket).
    serviceName String
    The id of the public cloud project.

    getCloudStorageObjectBucket Result

    The following output properties are available:

    Checksum string
    Computed hash representing the current target specification value.
    CreatedAt string
    Creation date of the bucket.
    CurrentState GetCloudStorageObjectBucketCurrentState
    Current observed state of the bucket:
    Encryption GetCloudStorageObjectBucketEncryption
    Current encryption configuration:
    Id string
    Bucket identifier.
    Location GetCloudStorageObjectBucketLocation
    Geographic region where the bucket is located:
    Name string
    Bucket name.
    ObjectLock GetCloudStorageObjectBucketObjectLock
    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).
    ServiceName string
    Tags Dictionary<string, string>
    Current metadata tags.
    UpdatedAt string
    Last update date of the bucket.
    Versioning GetCloudStorageObjectBucketVersioning
    Current versioning configuration:
    Checksum string
    Computed hash representing the current target specification value.
    CreatedAt string
    Creation date of the bucket.
    CurrentState GetCloudStorageObjectBucketCurrentState
    Current observed state of the bucket:
    Encryption GetCloudStorageObjectBucketEncryption
    Current encryption configuration:
    Id string
    Bucket identifier.
    Location GetCloudStorageObjectBucketLocation
    Geographic region where the bucket is located:
    Name string
    Bucket name.
    ObjectLock GetCloudStorageObjectBucketObjectLock
    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).
    ServiceName string
    Tags map[string]string
    Current metadata tags.
    UpdatedAt string
    Last update date of the bucket.
    Versioning GetCloudStorageObjectBucketVersioning
    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).
    service_name string
    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 GetCloudStorageObjectBucketCurrentState
    Current observed state of the bucket:
    encryption GetCloudStorageObjectBucketEncryption
    Current encryption configuration:
    id String
    Bucket identifier.
    location GetCloudStorageObjectBucketLocation
    Geographic region where the bucket is located:
    name String
    Bucket name.
    objectLock GetCloudStorageObjectBucketObjectLock
    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).
    serviceName String
    tags Map<String,String>
    Current metadata tags.
    updatedAt String
    Last update date of the bucket.
    versioning GetCloudStorageObjectBucketVersioning
    Current versioning configuration:
    checksum string
    Computed hash representing the current target specification value.
    createdAt string
    Creation date of the bucket.
    currentState GetCloudStorageObjectBucketCurrentState
    Current observed state of the bucket:
    encryption GetCloudStorageObjectBucketEncryption
    Current encryption configuration:
    id string
    Bucket identifier.
    location GetCloudStorageObjectBucketLocation
    Geographic region where the bucket is located:
    name string
    Bucket name.
    objectLock GetCloudStorageObjectBucketObjectLock
    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).
    serviceName string
    tags {[key: string]: string}
    Current metadata tags.
    updatedAt string
    Last update date of the bucket.
    versioning GetCloudStorageObjectBucketVersioning
    Current versioning configuration:
    checksum str
    Computed hash representing the current target specification value.
    created_at str
    Creation date of the bucket.
    current_state GetCloudStorageObjectBucketCurrentState
    Current observed state of the bucket:
    encryption GetCloudStorageObjectBucketEncryption
    Current encryption configuration:
    id str
    Bucket identifier.
    location GetCloudStorageObjectBucketLocation
    Geographic region where the bucket is located:
    name str
    Bucket name.
    object_lock GetCloudStorageObjectBucketObjectLock
    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).
    service_name str
    tags Mapping[str, str]
    Current metadata tags.
    updated_at str
    Last update date of the bucket.
    versioning GetCloudStorageObjectBucketVersioning
    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).
    serviceName String
    tags Map<String>
    Current metadata tags.
    updatedAt String
    Last update date of the bucket.
    versioning Property Map
    Current versioning configuration:

    Supporting Types

    GetCloudStorageObjectBucketCurrentState

    Encryption GetCloudStorageObjectBucketCurrentStateEncryption
    Current encryption configuration:
    Location GetCloudStorageObjectBucketCurrentStateLocation
    Geographic region where the bucket is located:
    Name string
    Bucket name.
    ObjectLock GetCloudStorageObjectBucketCurrentStateObjectLock
    Current object lock configuration:
    ObjectsCount int
    Bucket total objects count.
    ObjectsSize int
    Bucket total objects size in bytes.
    Tags Dictionary<string, string>
    Current metadata tags.
    Versioning GetCloudStorageObjectBucketCurrentStateVersioning
    Current versioning configuration:
    VirtualHost string
    Bucket virtual host, as a hostname without scheme (for example my-data-bucket.s3.gra.io.cloud.ovh.net).
    Encryption GetCloudStorageObjectBucketCurrentStateEncryption
    Current encryption configuration:
    Location GetCloudStorageObjectBucketCurrentStateLocation
    Geographic region where the bucket is located:
    Name string
    Bucket name.
    ObjectLock GetCloudStorageObjectBucketCurrentStateObjectLock
    Current object lock configuration:
    ObjectsCount int
    Bucket total objects count.
    ObjectsSize int
    Bucket total objects size in bytes.
    Tags map[string]string
    Current metadata tags.
    Versioning GetCloudStorageObjectBucketCurrentStateVersioning
    Current versioning configuration:
    VirtualHost string
    Bucket virtual host, as a hostname without scheme (for example my-data-bucket.s3.gra.io.cloud.ovh.net).
    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.
    objects_size number
    Bucket total objects size in bytes.
    tags map(string)
    Current metadata tags.
    versioning object
    Current versioning configuration:
    virtual_host string
    Bucket virtual host, as a hostname without scheme (for example my-data-bucket.s3.gra.io.cloud.ovh.net).
    encryption GetCloudStorageObjectBucketCurrentStateEncryption
    Current encryption configuration:
    location GetCloudStorageObjectBucketCurrentStateLocation
    Geographic region where the bucket is located:
    name String
    Bucket name.
    objectLock GetCloudStorageObjectBucketCurrentStateObjectLock
    Current object lock configuration:
    objectsCount Integer
    Bucket total objects count.
    objectsSize Integer
    Bucket total objects size in bytes.
    tags Map<String,String>
    Current metadata tags.
    versioning GetCloudStorageObjectBucketCurrentStateVersioning
    Current versioning configuration:
    virtualHost String
    Bucket virtual host, as a hostname without scheme (for example my-data-bucket.s3.gra.io.cloud.ovh.net).
    encryption GetCloudStorageObjectBucketCurrentStateEncryption
    Current encryption configuration:
    location GetCloudStorageObjectBucketCurrentStateLocation
    Geographic region where the bucket is located:
    name string
    Bucket name.
    objectLock GetCloudStorageObjectBucketCurrentStateObjectLock
    Current object lock configuration:
    objectsCount number
    Bucket total objects count.
    objectsSize number
    Bucket total objects size in bytes.
    tags {[key: string]: string}
    Current metadata tags.
    versioning GetCloudStorageObjectBucketCurrentStateVersioning
    Current versioning configuration:
    virtualHost string
    Bucket virtual host, as a hostname without scheme (for example my-data-bucket.s3.gra.io.cloud.ovh.net).
    encryption GetCloudStorageObjectBucketCurrentStateEncryption
    Current encryption configuration:
    location GetCloudStorageObjectBucketCurrentStateLocation
    Geographic region where the bucket is located:
    name str
    Bucket name.
    object_lock GetCloudStorageObjectBucketCurrentStateObjectLock
    Current object lock configuration:
    objects_count int
    Bucket total objects count.
    objects_size int
    Bucket total objects size in bytes.
    tags Mapping[str, str]
    Current metadata tags.
    versioning GetCloudStorageObjectBucketCurrentStateVersioning
    Current versioning configuration:
    virtual_host str
    Bucket virtual host, as a hostname without scheme (for example my-data-bucket.s3.gra.io.cloud.ovh.net).
    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.
    objectsSize Number
    Bucket total objects size in bytes.
    tags Map<String>
    Current metadata tags.
    versioning Property Map
    Current versioning configuration:
    virtualHost String
    Bucket virtual host, as a hostname without scheme (for example my-data-bucket.s3.gra.io.cloud.ovh.net).

    GetCloudStorageObjectBucketCurrentStateEncryption

    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.

    GetCloudStorageObjectBucketCurrentStateLocation

    Region string
    Region identifier.
    Region string
    Region identifier.
    region string
    Region identifier.
    region String
    Region identifier.
    region string
    Region identifier.
    region str
    Region identifier.
    region String
    Region identifier.

    GetCloudStorageObjectBucketCurrentStateObjectLock

    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.

    GetCloudStorageObjectBucketCurrentStateVersioning

    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.

    GetCloudStorageObjectBucketEncryption

    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.

    GetCloudStorageObjectBucketLocation

    Region string
    Region identifier.
    Region string
    Region identifier.
    region string
    Region identifier.
    region String
    Region identifier.
    region string
    Region identifier.
    region str
    Region identifier.
    region String
    Region identifier.

    GetCloudStorageObjectBucketObjectLock

    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.

    GetCloudStorageObjectBucketVersioning

    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