1. Registry
  2. Packages
  3. OVH
  4. API Docs
  5. CloudStorageObjectBucket
Viewing docs for OVHCloud v2.22.0
published on Monday, Oct 5, 2026 by OVHcloud
ovh logo
Viewing docs for OVHCloud v2.22.0
published on Monday, Oct 5, 2026 by OVHcloud

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

    Create CloudStorageObjectBucket Resource

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

    Constructor syntax

    new CloudStorageObjectBucket(name: string, args: CloudStorageObjectBucketArgs, opts?: CustomResourceOptions);
    @overload
    def CloudStorageObjectBucket(resource_name: str,
                                 args: CloudStorageObjectBucketArgs,
                                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def CloudStorageObjectBucket(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 region: Optional[str] = None,
                                 encryption: Optional[CloudStorageObjectBucketEncryptionArgs] = None,
                                 name: Optional[str] = None,
                                 object_lock: Optional[CloudStorageObjectBucketObjectLockArgs] = None,
                                 owner_user_id: Optional[str] = None,
                                 service_name: Optional[str] = None,
                                 tags: Optional[Mapping[str, str]] = None,
                                 versioning: Optional[CloudStorageObjectBucketVersioningArgs] = None)
    func NewCloudStorageObjectBucket(ctx *Context, name string, args CloudStorageObjectBucketArgs, opts ...ResourceOption) (*CloudStorageObjectBucket, error)
    public CloudStorageObjectBucket(string name, CloudStorageObjectBucketArgs args, CustomResourceOptions? opts = null)
    public CloudStorageObjectBucket(String name, CloudStorageObjectBucketArgs args)
    public CloudStorageObjectBucket(String name, CloudStorageObjectBucketArgs args, CustomResourceOptions options)
    
    type: ovh:CloudStorageObjectBucket
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "ovh_cloud_storage_object_bucket" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args CloudStorageObjectBucketArgs
    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 CloudStorageObjectBucketArgs
    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 CloudStorageObjectBucketArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CloudStorageObjectBucketArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CloudStorageObjectBucketArgs
    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 cloudStorageObjectBucketResource = new Ovh.CloudStorageObjectBucket("cloudStorageObjectBucketResource", new()
    {
        Region = "string",
        Encryption = new Ovh.Inputs.CloudStorageObjectBucketEncryptionArgs
        {
            Algorithm = "string",
        },
        Name = "string",
        ObjectLock = new Ovh.Inputs.CloudStorageObjectBucketObjectLockArgs
        {
            Mode = "string",
            RetentionDays = 0,
        },
        OwnerUserId = "string",
        ServiceName = "string",
        Tags = 
        {
            { "string", "string" },
        },
        Versioning = new Ovh.Inputs.CloudStorageObjectBucketVersioningArgs
        {
            Status = "string",
        },
    });
    
    example, err := ovh.NewCloudStorageObjectBucket(ctx, "cloudStorageObjectBucketResource", &ovh.CloudStorageObjectBucketArgs{
    	Region: pulumi.String("string"),
    	Encryption: &ovh.CloudStorageObjectBucketEncryptionArgs{
    		Algorithm: pulumi.String("string"),
    	},
    	Name: pulumi.String("string"),
    	ObjectLock: &ovh.CloudStorageObjectBucketObjectLockArgs{
    		Mode:          pulumi.String("string"),
    		RetentionDays: pulumi.Int(0),
    	},
    	OwnerUserId: pulumi.String("string"),
    	ServiceName: pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Versioning: &ovh.CloudStorageObjectBucketVersioningArgs{
    		Status: pulumi.String("string"),
    	},
    })
    
    resource "ovh_cloud_storage_object_bucket" "cloudStorageObjectBucketResource" {
      lifecycle {
        create_before_destroy = true
      }
      region = "string"
      encryption = {
        algorithm = "string"
      }
      name = "string"
      object_lock = {
        mode           = "string"
        retention_days = 0
      }
      owner_user_id = "string"
      service_name  = "string"
      tags = {
        "string" = "string"
      }
      versioning = {
        status = "string"
      }
    }
    
    var cloudStorageObjectBucketResource = new CloudStorageObjectBucket("cloudStorageObjectBucketResource", CloudStorageObjectBucketArgs.builder()
        .region("string")
        .encryption(CloudStorageObjectBucketEncryptionArgs.builder()
            .algorithm("string")
            .build())
        .name("string")
        .objectLock(CloudStorageObjectBucketObjectLockArgs.builder()
            .mode("string")
            .retentionDays(0)
            .build())
        .ownerUserId("string")
        .serviceName("string")
        .tags(Map.of("string", "string"))
        .versioning(CloudStorageObjectBucketVersioningArgs.builder()
            .status("string")
            .build())
        .build());
    
    cloud_storage_object_bucket_resource = ovh.CloudStorageObjectBucket("cloudStorageObjectBucketResource",
        region="string",
        encryption={
            "algorithm": "string",
        },
        name="string",
        object_lock={
            "mode": "string",
            "retention_days": 0,
        },
        owner_user_id="string",
        service_name="string",
        tags={
            "string": "string",
        },
        versioning={
            "status": "string",
        })
    
    const cloudStorageObjectBucketResource = new ovh.CloudStorageObjectBucket("cloudStorageObjectBucketResource", {
        region: "string",
        encryption: {
            algorithm: "string",
        },
        name: "string",
        objectLock: {
            mode: "string",
            retentionDays: 0,
        },
        ownerUserId: "string",
        serviceName: "string",
        tags: {
            string: "string",
        },
        versioning: {
            status: "string",
        },
    });
    
    type: ovh:CloudStorageObjectBucket
    properties:
        encryption:
            algorithm: string
        name: string
        objectLock:
            mode: string
            retentionDays: 0
        ownerUserId: string
        region: string
        serviceName: string
        tags:
            string: string
        versioning:
            status: string
    

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

    Region string
    Region identifier where the bucket will be created. Must be upper-case (e.g. GRA, SBG, BHS). Changing this value recreates the resource.
    Encryption CloudStorageObjectBucketEncryption
    Server-side encryption configuration:
    Name string
    Bucket name (must be globally unique and DNS-compatible): 3 to 63 characters, lowercase letters, digits, dots and hyphens only, starting and ending with a letter or a digit. Changing this value recreates the resource.
    ObjectLock CloudStorageObjectBucketObjectLock
    Object lock (WORM) configuration. Requires versioning to be set with status = "ENABLED". Object lock can only be armed at bucket creation. Adding, changing or removing this block recreates the resource.
    OwnerUserId string
    Owner user identifier.
    ServiceName string
    Service name of the resource representing the id of the cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used. Changing this value recreates the resource.
    Tags Dictionary<string, string>
    Metadata tags for the bucket, as a map of strings.
    Versioning CloudStorageObjectBucketVersioning
    Versioning configuration:
    Region string
    Region identifier where the bucket will be created. Must be upper-case (e.g. GRA, SBG, BHS). Changing this value recreates the resource.
    Encryption CloudStorageObjectBucketEncryptionArgs
    Server-side encryption configuration:
    Name string
    Bucket name (must be globally unique and DNS-compatible): 3 to 63 characters, lowercase letters, digits, dots and hyphens only, starting and ending with a letter or a digit. Changing this value recreates the resource.
    ObjectLock CloudStorageObjectBucketObjectLockArgs
    Object lock (WORM) configuration. Requires versioning to be set with status = "ENABLED". Object lock can only be armed at bucket creation. Adding, changing or removing this block recreates the resource.
    OwnerUserId string
    Owner user identifier.
    ServiceName string
    Service name of the resource representing the id of the cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used. Changing this value recreates the resource.
    Tags map[string]string
    Metadata tags for the bucket, as a map of strings.
    Versioning CloudStorageObjectBucketVersioningArgs
    Versioning configuration:
    region string
    Region identifier where the bucket will be created. Must be upper-case (e.g. GRA, SBG, BHS). Changing this value recreates the resource.
    encryption object
    Server-side encryption configuration:
    name string
    Bucket name (must be globally unique and DNS-compatible): 3 to 63 characters, lowercase letters, digits, dots and hyphens only, starting and ending with a letter or a digit. Changing this value recreates the resource.
    object_lock object
    Object lock (WORM) configuration. Requires versioning to be set with status = "ENABLED". Object lock can only be armed at bucket creation. Adding, changing or removing this block recreates the resource.
    owner_user_id string
    Owner user identifier.
    service_name string
    Service name of the resource representing the id of the cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used. Changing this value recreates the resource.
    tags map(string)
    Metadata tags for the bucket, as a map of strings.
    versioning object
    Versioning configuration:
    region String
    Region identifier where the bucket will be created. Must be upper-case (e.g. GRA, SBG, BHS). Changing this value recreates the resource.
    encryption CloudStorageObjectBucketEncryption
    Server-side encryption configuration:
    name String
    Bucket name (must be globally unique and DNS-compatible): 3 to 63 characters, lowercase letters, digits, dots and hyphens only, starting and ending with a letter or a digit. Changing this value recreates the resource.
    objectLock CloudStorageObjectBucketObjectLock
    Object lock (WORM) configuration. Requires versioning to be set with status = "ENABLED". Object lock can only be armed at bucket creation. Adding, changing or removing this block recreates the resource.
    ownerUserId String
    Owner user identifier.
    serviceName String
    Service name of the resource representing the id of the cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used. Changing this value recreates the resource.
    tags Map<String,String>
    Metadata tags for the bucket, as a map of strings.
    versioning CloudStorageObjectBucketVersioning
    Versioning configuration:
    region string
    Region identifier where the bucket will be created. Must be upper-case (e.g. GRA, SBG, BHS). Changing this value recreates the resource.
    encryption CloudStorageObjectBucketEncryption
    Server-side encryption configuration:
    name string
    Bucket name (must be globally unique and DNS-compatible): 3 to 63 characters, lowercase letters, digits, dots and hyphens only, starting and ending with a letter or a digit. Changing this value recreates the resource.
    objectLock CloudStorageObjectBucketObjectLock
    Object lock (WORM) configuration. Requires versioning to be set with status = "ENABLED". Object lock can only be armed at bucket creation. Adding, changing or removing this block recreates the resource.
    ownerUserId string
    Owner user identifier.
    serviceName string
    Service name of the resource representing the id of the cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used. Changing this value recreates the resource.
    tags {[key: string]: string}
    Metadata tags for the bucket, as a map of strings.
    versioning CloudStorageObjectBucketVersioning
    Versioning configuration:
    region str
    Region identifier where the bucket will be created. Must be upper-case (e.g. GRA, SBG, BHS). Changing this value recreates the resource.
    encryption CloudStorageObjectBucketEncryptionArgs
    Server-side encryption configuration:
    name str
    Bucket name (must be globally unique and DNS-compatible): 3 to 63 characters, lowercase letters, digits, dots and hyphens only, starting and ending with a letter or a digit. Changing this value recreates the resource.
    object_lock CloudStorageObjectBucketObjectLockArgs
    Object lock (WORM) configuration. Requires versioning to be set with status = "ENABLED". Object lock can only be armed at bucket creation. Adding, changing or removing this block recreates the resource.
    owner_user_id str
    Owner user identifier.
    service_name str
    Service name of the resource representing the id of the cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used. Changing this value recreates the resource.
    tags Mapping[str, str]
    Metadata tags for the bucket, as a map of strings.
    versioning CloudStorageObjectBucketVersioningArgs
    Versioning configuration:
    region String
    Region identifier where the bucket will be created. Must be upper-case (e.g. GRA, SBG, BHS). Changing this value recreates the resource.
    encryption Property Map
    Server-side encryption configuration:
    name String
    Bucket name (must be globally unique and DNS-compatible): 3 to 63 characters, lowercase letters, digits, dots and hyphens only, starting and ending with a letter or a digit. Changing this value recreates the resource.
    objectLock Property Map
    Object lock (WORM) configuration. Requires versioning to be set with status = "ENABLED". Object lock can only be armed at bucket creation. Adding, changing or removing this block recreates the resource.
    ownerUserId String
    Owner user identifier.
    serviceName String
    Service name of the resource representing the id of the cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used. Changing this value recreates the resource.
    tags Map<String>
    Metadata tags for the bucket, as a map of strings.
    versioning Property Map
    Versioning configuration:

    Outputs

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

    Checksum string
    Computed hash representing the current target specification value.
    CreatedAt string
    Creation date of the bucket.
    CurrentState CloudStorageObjectBucketCurrentState
    Current observed state of the bucket:
    Id string
    The provider-assigned unique ID for this managed resource.
    ResourceStatus string
    Bucket readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING).
    UpdatedAt string
    Last update date of the bucket.
    Checksum string
    Computed hash representing the current target specification value.
    CreatedAt string
    Creation date of the bucket.
    CurrentState CloudStorageObjectBucketCurrentState
    Current observed state of the bucket:
    Id string
    The provider-assigned unique ID for this managed resource.
    ResourceStatus string
    Bucket readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING).
    UpdatedAt string
    Last update date of the bucket.
    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:
    id string
    The provider-assigned unique ID for this managed resource.
    resource_status string
    Bucket readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING).
    updated_at string
    Last update date of the bucket.
    checksum String
    Computed hash representing the current target specification value.
    createdAt String
    Creation date of the bucket.
    currentState CloudStorageObjectBucketCurrentState
    Current observed state of the bucket:
    id String
    The provider-assigned unique ID for this managed resource.
    resourceStatus String
    Bucket readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING).
    updatedAt String
    Last update date of the bucket.
    checksum string
    Computed hash representing the current target specification value.
    createdAt string
    Creation date of the bucket.
    currentState CloudStorageObjectBucketCurrentState
    Current observed state of the bucket:
    id string
    The provider-assigned unique ID for this managed resource.
    resourceStatus string
    Bucket readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING).
    updatedAt string
    Last update date of the bucket.
    checksum str
    Computed hash representing the current target specification value.
    created_at str
    Creation date of the bucket.
    current_state CloudStorageObjectBucketCurrentState
    Current observed state of the bucket:
    id str
    The provider-assigned unique ID for this managed resource.
    resource_status str
    Bucket readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING).
    updated_at str
    Last update date of the bucket.
    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:
    id String
    The provider-assigned unique ID for this managed resource.
    resourceStatus String
    Bucket readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING).
    updatedAt String
    Last update date of the bucket.

    Look up Existing CloudStorageObjectBucket Resource

    Get an existing CloudStorageObjectBucket 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?: CloudStorageObjectBucketState, opts?: CustomResourceOptions): CloudStorageObjectBucket
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            checksum: Optional[str] = None,
            created_at: Optional[str] = None,
            current_state: Optional[CloudStorageObjectBucketCurrentStateArgs] = None,
            encryption: Optional[CloudStorageObjectBucketEncryptionArgs] = None,
            name: Optional[str] = None,
            object_lock: Optional[CloudStorageObjectBucketObjectLockArgs] = None,
            owner_user_id: Optional[str] = None,
            region: Optional[str] = None,
            resource_status: Optional[str] = None,
            service_name: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            updated_at: Optional[str] = None,
            versioning: Optional[CloudStorageObjectBucketVersioningArgs] = None) -> CloudStorageObjectBucket
    func GetCloudStorageObjectBucket(ctx *Context, name string, id IDInput, state *CloudStorageObjectBucketState, opts ...ResourceOption) (*CloudStorageObjectBucket, error)
    public static CloudStorageObjectBucket Get(string name, Input<string> id, CloudStorageObjectBucketState? state, CustomResourceOptions? opts = null)
    public static CloudStorageObjectBucket get(String name, Output<String> id, CloudStorageObjectBucketState state, CustomResourceOptions options)
    resources:  _:    type: ovh:CloudStorageObjectBucket    get:      id: ${id}
    import {
      to = ovh_cloud_storage_object_bucket.example
      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:
    Checksum string
    Computed hash representing the current target specification value.
    CreatedAt string
    Creation date of the bucket.
    CurrentState CloudStorageObjectBucketCurrentState
    Current observed state of the bucket:
    Encryption CloudStorageObjectBucketEncryption
    Server-side encryption configuration:
    Name string
    Bucket name (must be globally unique and DNS-compatible): 3 to 63 characters, lowercase letters, digits, dots and hyphens only, starting and ending with a letter or a digit. Changing this value recreates the resource.
    ObjectLock CloudStorageObjectBucketObjectLock
    Object lock (WORM) configuration. Requires versioning to be set with status = "ENABLED". Object lock can only be armed at bucket creation. Adding, changing or removing this block recreates the resource.
    OwnerUserId string
    Owner user identifier.
    Region string
    Region identifier where the bucket will be created. Must be upper-case (e.g. GRA, SBG, BHS). Changing this value recreates the resource.
    ResourceStatus string
    Bucket readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING).
    ServiceName string
    Service name of the resource representing the id of the cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used. Changing this value recreates the resource.
    Tags Dictionary<string, string>
    Metadata tags for the bucket, as a map of strings.
    UpdatedAt string
    Last update date of the bucket.
    Versioning CloudStorageObjectBucketVersioning
    Versioning configuration:
    Checksum string
    Computed hash representing the current target specification value.
    CreatedAt string
    Creation date of the bucket.
    CurrentState CloudStorageObjectBucketCurrentStateArgs
    Current observed state of the bucket:
    Encryption CloudStorageObjectBucketEncryptionArgs
    Server-side encryption configuration:
    Name string
    Bucket name (must be globally unique and DNS-compatible): 3 to 63 characters, lowercase letters, digits, dots and hyphens only, starting and ending with a letter or a digit. Changing this value recreates the resource.
    ObjectLock CloudStorageObjectBucketObjectLockArgs
    Object lock (WORM) configuration. Requires versioning to be set with status = "ENABLED". Object lock can only be armed at bucket creation. Adding, changing or removing this block recreates the resource.
    OwnerUserId string
    Owner user identifier.
    Region string
    Region identifier where the bucket will be created. Must be upper-case (e.g. GRA, SBG, BHS). Changing this value recreates the resource.
    ResourceStatus string
    Bucket readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING).
    ServiceName string
    Service name of the resource representing the id of the cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used. Changing this value recreates the resource.
    Tags map[string]string
    Metadata tags for the bucket, as a map of strings.
    UpdatedAt string
    Last update date of the bucket.
    Versioning CloudStorageObjectBucketVersioningArgs
    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
    Server-side encryption configuration:
    name string
    Bucket name (must be globally unique and DNS-compatible): 3 to 63 characters, lowercase letters, digits, dots and hyphens only, starting and ending with a letter or a digit. Changing this value recreates the resource.
    object_lock object
    Object lock (WORM) configuration. Requires versioning to be set with status = "ENABLED". Object lock can only be armed at bucket creation. Adding, changing or removing this block recreates the resource.
    owner_user_id string
    Owner user identifier.
    region string
    Region identifier where the bucket will be created. Must be upper-case (e.g. GRA, SBG, BHS). Changing this value recreates the resource.
    resource_status string
    Bucket readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING).
    service_name string
    Service name of the resource representing the id of the cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used. Changing this value recreates the resource.
    tags map(string)
    Metadata tags for the bucket, as a map of strings.
    updated_at string
    Last update date of the bucket.
    versioning object
    Versioning configuration:
    checksum String
    Computed hash representing the current target specification value.
    createdAt String
    Creation date of the bucket.
    currentState CloudStorageObjectBucketCurrentState
    Current observed state of the bucket:
    encryption CloudStorageObjectBucketEncryption
    Server-side encryption configuration:
    name String
    Bucket name (must be globally unique and DNS-compatible): 3 to 63 characters, lowercase letters, digits, dots and hyphens only, starting and ending with a letter or a digit. Changing this value recreates the resource.
    objectLock CloudStorageObjectBucketObjectLock
    Object lock (WORM) configuration. Requires versioning to be set with status = "ENABLED". Object lock can only be armed at bucket creation. Adding, changing or removing this block recreates the resource.
    ownerUserId String
    Owner user identifier.
    region String
    Region identifier where the bucket will be created. Must be upper-case (e.g. GRA, SBG, BHS). Changing this value recreates the resource.
    resourceStatus String
    Bucket readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING).
    serviceName String
    Service name of the resource representing the id of the cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used. Changing this value recreates the resource.
    tags Map<String,String>
    Metadata tags for the bucket, as a map of strings.
    updatedAt String
    Last update date of the bucket.
    versioning CloudStorageObjectBucketVersioning
    Versioning configuration:
    checksum string
    Computed hash representing the current target specification value.
    createdAt string
    Creation date of the bucket.
    currentState CloudStorageObjectBucketCurrentState
    Current observed state of the bucket:
    encryption CloudStorageObjectBucketEncryption
    Server-side encryption configuration:
    name string
    Bucket name (must be globally unique and DNS-compatible): 3 to 63 characters, lowercase letters, digits, dots and hyphens only, starting and ending with a letter or a digit. Changing this value recreates the resource.
    objectLock CloudStorageObjectBucketObjectLock
    Object lock (WORM) configuration. Requires versioning to be set with status = "ENABLED". Object lock can only be armed at bucket creation. Adding, changing or removing this block recreates the resource.
    ownerUserId string
    Owner user identifier.
    region string
    Region identifier where the bucket will be created. Must be upper-case (e.g. GRA, SBG, BHS). Changing this value recreates the resource.
    resourceStatus string
    Bucket readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING).
    serviceName string
    Service name of the resource representing the id of the cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used. Changing this value recreates the resource.
    tags {[key: string]: string}
    Metadata tags for the bucket, as a map of strings.
    updatedAt string
    Last update date of the bucket.
    versioning CloudStorageObjectBucketVersioning
    Versioning configuration:
    checksum str
    Computed hash representing the current target specification value.
    created_at str
    Creation date of the bucket.
    current_state CloudStorageObjectBucketCurrentStateArgs
    Current observed state of the bucket:
    encryption CloudStorageObjectBucketEncryptionArgs
    Server-side encryption configuration:
    name str
    Bucket name (must be globally unique and DNS-compatible): 3 to 63 characters, lowercase letters, digits, dots and hyphens only, starting and ending with a letter or a digit. Changing this value recreates the resource.
    object_lock CloudStorageObjectBucketObjectLockArgs
    Object lock (WORM) configuration. Requires versioning to be set with status = "ENABLED". Object lock can only be armed at bucket creation. Adding, changing or removing this block recreates the resource.
    owner_user_id str
    Owner user identifier.
    region str
    Region identifier where the bucket will be created. Must be upper-case (e.g. GRA, SBG, BHS). Changing this value recreates the resource.
    resource_status str
    Bucket readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING).
    service_name str
    Service name of the resource representing the id of the cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used. Changing this value recreates the resource.
    tags Mapping[str, str]
    Metadata tags for the bucket, as a map of strings.
    updated_at str
    Last update date of the bucket.
    versioning CloudStorageObjectBucketVersioningArgs
    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
    Server-side encryption configuration:
    name String
    Bucket name (must be globally unique and DNS-compatible): 3 to 63 characters, lowercase letters, digits, dots and hyphens only, starting and ending with a letter or a digit. Changing this value recreates the resource.
    objectLock Property Map
    Object lock (WORM) configuration. Requires versioning to be set with status = "ENABLED". Object lock can only be armed at bucket creation. Adding, changing or removing this block recreates the resource.
    ownerUserId String
    Owner user identifier.
    region String
    Region identifier where the bucket will be created. Must be upper-case (e.g. GRA, SBG, BHS). Changing this value recreates the resource.
    resourceStatus String
    Bucket readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING).
    serviceName String
    Service name of the resource representing the id of the cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used. Changing this value recreates the resource.
    tags Map<String>
    Metadata tags for the bucket, as a map of strings.
    updatedAt String
    Last update date of the bucket.
    versioning Property Map
    Versioning configuration:

    Supporting Types

    CloudStorageObjectBucketCurrentState, CloudStorageObjectBucketCurrentStateArgs

    Encryption CloudStorageObjectBucketCurrentStateEncryption
    Server-side encryption configuration:
    Location CloudStorageObjectBucketCurrentStateLocation
    Geographic region where the bucket is located:
    Name string
    Bucket name (must be globally unique and DNS-compatible): 3 to 63 characters, lowercase letters, digits, dots and hyphens only, starting and ending with a letter or a digit. Changing this value recreates the resource.
    ObjectLock CloudStorageObjectBucketCurrentStateObjectLock
    Object lock (WORM) configuration. Requires versioning to be set with status = "ENABLED". Object lock can only be armed at bucket creation. Adding, changing or removing this block recreates the resource.
    ObjectsCount int
    Bucket total objects count. Only returned on a single bucket read.
    ObjectsSize int
    Bucket total objects size in bytes. Only returned on a single bucket read.
    Tags Dictionary<string, string>
    Metadata tags for the bucket, as a map of strings.
    Versioning CloudStorageObjectBucketCurrentStateVersioning
    Versioning configuration:
    VirtualHost string
    Bucket virtual host, as a hostname without scheme (for example my-data-bucket.s3.gra.io.cloud.ovh.net). Only returned on a single bucket read.
    Encryption CloudStorageObjectBucketCurrentStateEncryption
    Server-side encryption configuration:
    Location CloudStorageObjectBucketCurrentStateLocation
    Geographic region where the bucket is located:
    Name string
    Bucket name (must be globally unique and DNS-compatible): 3 to 63 characters, lowercase letters, digits, dots and hyphens only, starting and ending with a letter or a digit. Changing this value recreates the resource.
    ObjectLock CloudStorageObjectBucketCurrentStateObjectLock
    Object lock (WORM) configuration. Requires versioning to be set with status = "ENABLED". Object lock can only be armed at bucket creation. Adding, changing or removing this block recreates the resource.
    ObjectsCount int
    Bucket total objects count. Only returned on a single bucket read.
    ObjectsSize int
    Bucket total objects size in bytes. Only returned on a single bucket read.
    Tags map[string]string
    Metadata tags for the bucket, as a map of strings.
    Versioning CloudStorageObjectBucketCurrentStateVersioning
    Versioning configuration:
    VirtualHost string
    Bucket virtual host, as a hostname without scheme (for example my-data-bucket.s3.gra.io.cloud.ovh.net). Only returned on a single bucket read.
    encryption object
    Server-side encryption configuration:
    location object
    Geographic region where the bucket is located:
    name string
    Bucket name (must be globally unique and DNS-compatible): 3 to 63 characters, lowercase letters, digits, dots and hyphens only, starting and ending with a letter or a digit. Changing this value recreates the resource.
    object_lock object
    Object lock (WORM) configuration. Requires versioning to be set with status = "ENABLED". Object lock can only be armed at bucket creation. Adding, changing or removing this block recreates the resource.
    objects_count number
    Bucket total objects count. Only returned on a single bucket read.
    objects_size number
    Bucket total objects size in bytes. Only returned on a single bucket read.
    tags map(string)
    Metadata tags for the bucket, as a map of strings.
    versioning object
    Versioning configuration:
    virtual_host string
    Bucket virtual host, as a hostname without scheme (for example my-data-bucket.s3.gra.io.cloud.ovh.net). Only returned on a single bucket read.
    encryption CloudStorageObjectBucketCurrentStateEncryption
    Server-side encryption configuration:
    location CloudStorageObjectBucketCurrentStateLocation
    Geographic region where the bucket is located:
    name String
    Bucket name (must be globally unique and DNS-compatible): 3 to 63 characters, lowercase letters, digits, dots and hyphens only, starting and ending with a letter or a digit. Changing this value recreates the resource.
    objectLock CloudStorageObjectBucketCurrentStateObjectLock
    Object lock (WORM) configuration. Requires versioning to be set with status = "ENABLED". Object lock can only be armed at bucket creation. Adding, changing or removing this block recreates the resource.
    objectsCount Integer
    Bucket total objects count. Only returned on a single bucket read.
    objectsSize Integer
    Bucket total objects size in bytes. Only returned on a single bucket read.
    tags Map<String,String>
    Metadata tags for the bucket, as a map of strings.
    versioning CloudStorageObjectBucketCurrentStateVersioning
    Versioning configuration:
    virtualHost String
    Bucket virtual host, as a hostname without scheme (for example my-data-bucket.s3.gra.io.cloud.ovh.net). Only returned on a single bucket read.
    encryption CloudStorageObjectBucketCurrentStateEncryption
    Server-side encryption configuration:
    location CloudStorageObjectBucketCurrentStateLocation
    Geographic region where the bucket is located:
    name string
    Bucket name (must be globally unique and DNS-compatible): 3 to 63 characters, lowercase letters, digits, dots and hyphens only, starting and ending with a letter or a digit. Changing this value recreates the resource.
    objectLock CloudStorageObjectBucketCurrentStateObjectLock
    Object lock (WORM) configuration. Requires versioning to be set with status = "ENABLED". Object lock can only be armed at bucket creation. Adding, changing or removing this block recreates the resource.
    objectsCount number
    Bucket total objects count. Only returned on a single bucket read.
    objectsSize number
    Bucket total objects size in bytes. Only returned on a single bucket read.
    tags {[key: string]: string}
    Metadata tags for the bucket, as a map of strings.
    versioning CloudStorageObjectBucketCurrentStateVersioning
    Versioning configuration:
    virtualHost string
    Bucket virtual host, as a hostname without scheme (for example my-data-bucket.s3.gra.io.cloud.ovh.net). Only returned on a single bucket read.
    encryption CloudStorageObjectBucketCurrentStateEncryption
    Server-side encryption configuration:
    location CloudStorageObjectBucketCurrentStateLocation
    Geographic region where the bucket is located:
    name str
    Bucket name (must be globally unique and DNS-compatible): 3 to 63 characters, lowercase letters, digits, dots and hyphens only, starting and ending with a letter or a digit. Changing this value recreates the resource.
    object_lock CloudStorageObjectBucketCurrentStateObjectLock
    Object lock (WORM) configuration. Requires versioning to be set with status = "ENABLED". Object lock can only be armed at bucket creation. Adding, changing or removing this block recreates the resource.
    objects_count int
    Bucket total objects count. Only returned on a single bucket read.
    objects_size int
    Bucket total objects size in bytes. Only returned on a single bucket read.
    tags Mapping[str, str]
    Metadata tags for the bucket, as a map of strings.
    versioning CloudStorageObjectBucketCurrentStateVersioning
    Versioning configuration:
    virtual_host str
    Bucket virtual host, as a hostname without scheme (for example my-data-bucket.s3.gra.io.cloud.ovh.net). Only returned on a single bucket read.
    encryption Property Map
    Server-side encryption configuration:
    location Property Map
    Geographic region where the bucket is located:
    name String
    Bucket name (must be globally unique and DNS-compatible): 3 to 63 characters, lowercase letters, digits, dots and hyphens only, starting and ending with a letter or a digit. Changing this value recreates the resource.
    objectLock Property Map
    Object lock (WORM) configuration. Requires versioning to be set with status = "ENABLED". Object lock can only be armed at bucket creation. Adding, changing or removing this block recreates the resource.
    objectsCount Number
    Bucket total objects count. Only returned on a single bucket read.
    objectsSize Number
    Bucket total objects size in bytes. Only returned on a single bucket read.
    tags Map<String>
    Metadata tags for the bucket, as a map of strings.
    versioning Property Map
    Versioning configuration:
    virtualHost String
    Bucket virtual host, as a hostname without scheme (for example my-data-bucket.s3.gra.io.cloud.ovh.net). Only returned on a single bucket read.

    CloudStorageObjectBucketCurrentStateEncryption, CloudStorageObjectBucketCurrentStateEncryptionArgs

    Algorithm string
    Encryption algorithm. One of AES256, PLAINTEXT.
    Algorithm string
    Encryption algorithm. One of AES256, PLAINTEXT.
    algorithm string
    Encryption algorithm. One of AES256, PLAINTEXT.
    algorithm String
    Encryption algorithm. One of AES256, PLAINTEXT.
    algorithm string
    Encryption algorithm. One of AES256, PLAINTEXT.
    algorithm str
    Encryption algorithm. One of AES256, PLAINTEXT.
    algorithm String
    Encryption algorithm. One of AES256, PLAINTEXT.

    CloudStorageObjectBucketCurrentStateLocation, CloudStorageObjectBucketCurrentStateLocationArgs

    Region string
    Region identifier where the bucket will be created. Must be upper-case (e.g. GRA, SBG, BHS). Changing this value recreates the resource.
    Region string
    Region identifier where the bucket will be created. Must be upper-case (e.g. GRA, SBG, BHS). Changing this value recreates the resource.
    region string
    Region identifier where the bucket will be created. Must be upper-case (e.g. GRA, SBG, BHS). Changing this value recreates the resource.
    region String
    Region identifier where the bucket will be created. Must be upper-case (e.g. GRA, SBG, BHS). Changing this value recreates the resource.
    region string
    Region identifier where the bucket will be created. Must be upper-case (e.g. GRA, SBG, BHS). Changing this value recreates the resource.
    region str
    Region identifier where the bucket will be created. Must be upper-case (e.g. GRA, SBG, BHS). Changing this value recreates the resource.
    region String
    Region identifier where the bucket will be created. Must be upper-case (e.g. GRA, SBG, BHS). Changing this value recreates the resource.

    CloudStorageObjectBucketCurrentStateObjectLock, CloudStorageObjectBucketCurrentStateObjectLockArgs

    Mode string
    Object lock retention mode. One of COMPLIANCE, GOVERNANCE.
    RetentionDays int
    Number of days to retain objects. Must be at least 1.
    RetentionYears int
    Number of years to retain objects
    Mode string
    Object lock retention mode. One of COMPLIANCE, GOVERNANCE.
    RetentionDays int
    Number of days to retain objects. Must be at least 1.
    RetentionYears int
    Number of years to retain objects
    mode string
    Object lock retention mode. One of COMPLIANCE, GOVERNANCE.
    retention_days number
    Number of days to retain objects. Must be at least 1.
    retention_years number
    Number of years to retain objects
    mode String
    Object lock retention mode. One of COMPLIANCE, GOVERNANCE.
    retentionDays Integer
    Number of days to retain objects. Must be at least 1.
    retentionYears Integer
    Number of years to retain objects
    mode string
    Object lock retention mode. One of COMPLIANCE, GOVERNANCE.
    retentionDays number
    Number of days to retain objects. Must be at least 1.
    retentionYears number
    Number of years to retain objects
    mode str
    Object lock retention mode. One of COMPLIANCE, GOVERNANCE.
    retention_days int
    Number of days to retain objects. Must be at least 1.
    retention_years int
    Number of years to retain objects
    mode String
    Object lock retention mode. One of COMPLIANCE, GOVERNANCE.
    retentionDays Number
    Number of days to retain objects. Must be at least 1.
    retentionYears Number
    Number of years to retain objects

    CloudStorageObjectBucketCurrentStateVersioning, CloudStorageObjectBucketCurrentStateVersioningArgs

    Status string
    Versioning status. One of DISABLED, ENABLED, SUSPENDED.
    Status string
    Versioning status. One of DISABLED, ENABLED, SUSPENDED.
    status string
    Versioning status. One of DISABLED, ENABLED, SUSPENDED.
    status String
    Versioning status. One of DISABLED, ENABLED, SUSPENDED.
    status string
    Versioning status. One of DISABLED, ENABLED, SUSPENDED.
    status str
    Versioning status. One of DISABLED, ENABLED, SUSPENDED.
    status String
    Versioning status. One of DISABLED, ENABLED, SUSPENDED.

    CloudStorageObjectBucketEncryption, CloudStorageObjectBucketEncryptionArgs

    Algorithm string
    Encryption algorithm. One of AES256, PLAINTEXT.
    Algorithm string
    Encryption algorithm. One of AES256, PLAINTEXT.
    algorithm string
    Encryption algorithm. One of AES256, PLAINTEXT.
    algorithm String
    Encryption algorithm. One of AES256, PLAINTEXT.
    algorithm string
    Encryption algorithm. One of AES256, PLAINTEXT.
    algorithm str
    Encryption algorithm. One of AES256, PLAINTEXT.
    algorithm String
    Encryption algorithm. One of AES256, PLAINTEXT.

    CloudStorageObjectBucketObjectLock, CloudStorageObjectBucketObjectLockArgs

    Mode string
    Object lock retention mode. One of COMPLIANCE, GOVERNANCE.
    RetentionDays int
    Number of days to retain objects. Must be at least 1.
    Mode string
    Object lock retention mode. One of COMPLIANCE, GOVERNANCE.
    RetentionDays int
    Number of days to retain objects. Must be at least 1.
    mode string
    Object lock retention mode. One of COMPLIANCE, GOVERNANCE.
    retention_days number
    Number of days to retain objects. Must be at least 1.
    mode String
    Object lock retention mode. One of COMPLIANCE, GOVERNANCE.
    retentionDays Integer
    Number of days to retain objects. Must be at least 1.
    mode string
    Object lock retention mode. One of COMPLIANCE, GOVERNANCE.
    retentionDays number
    Number of days to retain objects. Must be at least 1.
    mode str
    Object lock retention mode. One of COMPLIANCE, GOVERNANCE.
    retention_days int
    Number of days to retain objects. Must be at least 1.
    mode String
    Object lock retention mode. One of COMPLIANCE, GOVERNANCE.
    retentionDays Number
    Number of days to retain objects. Must be at least 1.

    CloudStorageObjectBucketVersioning, CloudStorageObjectBucketVersioningArgs

    Status string
    Versioning status. One of DISABLED, ENABLED, SUSPENDED.
    Status string
    Versioning status. One of DISABLED, ENABLED, SUSPENDED.
    status string
    Versioning status. One of DISABLED, ENABLED, SUSPENDED.
    status String
    Versioning status. One of DISABLED, ENABLED, SUSPENDED.
    status string
    Versioning status. One of DISABLED, ENABLED, SUSPENDED.
    status str
    Versioning status. One of DISABLED, ENABLED, SUSPENDED.
    status String
    Versioning status. One of DISABLED, ENABLED, SUSPENDED.

    Import

    An S3™ compatible bucket can be imported using the service_name and the bucket id, separated by /:

    terraform

    import {

    to = ovh_cloud_storage_object_bucket.bucket

    id = “<service_name>/<bucket_id>”

    }

    ~> NOTE The bucket id is the bare bucket name on a single-region API instance, and <REGION>_<name> (for example GRA_my-data-bucket) on a multi-region one.

    bash

    $ pulumi import ovh:index/cloudStorageObjectBucket:CloudStorageObjectBucket bucket service_name/bucket_id
    

    To learn more about importing existing cloud resources, see Importing resources.

    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

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial