1. Packages
  2. Packages
  3. Ionoscloud
  4. API Docs
  5. objectstorage
  6. getUserBucket
Viewing docs for IonosCloud v0.3.1
published on Wednesday, Jun 10, 2026 by ionos-cloud
ionoscloud logo
Viewing docs for IonosCloud v0.3.1
published on Wednesday, Jun 10, 2026 by ionos-cloud

    The User Object Storage Bucket data source can be used to look up an existing user-owned bucket by name and region.

    ⚠️ Deprecation notice: User-owned buckets are a legacy bucket type. Use ionoscloud.objectstorage.Bucket (contract-owned) for new workloads.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ionoscloud from "@ionos-cloud/sdk-pulumi";
    
    const example = ionoscloud.objectstorage.getUserBucket({
        name: "my-bucket",
        region: "de",
    });
    
    import pulumi
    import pulumi_ionoscloud as ionoscloud
    
    example = ionoscloud.objectstorage.get_user_bucket(name="my-bucket",
        region="de")
    
    package main
    
    import (
    	"github.com/ionos-cloud/pulumi-ionoscloud/sdk/go/ionoscloud/objectstorage"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := objectstorage.LookupUserBucket(ctx, &objectstorage.LookupUserBucketArgs{
    			Name:   "my-bucket",
    			Region: "de",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Ionoscloud = Ionoscloud.Pulumi.Ionoscloud;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Ionoscloud.Objectstorage.GetUserBucket.Invoke(new()
        {
            Name = "my-bucket",
            Region = "de",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ionoscloud.objectstorage.ObjectstorageFunctions;
    import com.pulumi.ionoscloud.objectstorage.inputs.GetUserBucketArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var example = ObjectstorageFunctions.getUserBucket(GetUserBucketArgs.builder()
                .name("my-bucket")
                .region("de")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: ionoscloud:objectstorage:getUserBucket
          arguments:
            name: my-bucket
            region: de
    
    pulumi {
      required_providers {
        ionoscloud = {
          source = "pulumi/ionoscloud"
        }
      }
    }
    
    data "ionoscloud_objectstorage_getuserbucket" "example" {
      name   = "my-bucket"
      region = "de"
    }
    

    Using getUserBucket

    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 getUserBucket(args: GetUserBucketArgs, opts?: InvokeOptions): Promise<GetUserBucketResult>
    function getUserBucketOutput(args: GetUserBucketOutputArgs, opts?: InvokeOptions): Output<GetUserBucketResult>
    def get_user_bucket(name: Optional[str] = None,
                        region: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetUserBucketResult
    def get_user_bucket_output(name: pulumi.Input[Optional[str]] = None,
                        region: pulumi.Input[Optional[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetUserBucketResult]
    func LookupUserBucket(ctx *Context, args *LookupUserBucketArgs, opts ...InvokeOption) (*LookupUserBucketResult, error)
    func LookupUserBucketOutput(ctx *Context, args *LookupUserBucketOutputArgs, opts ...InvokeOption) LookupUserBucketResultOutput

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

    public static class GetUserBucket 
    {
        public static Task<GetUserBucketResult> InvokeAsync(GetUserBucketArgs args, InvokeOptions? opts = null)
        public static Output<GetUserBucketResult> Invoke(GetUserBucketInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetUserBucketResult> getUserBucket(GetUserBucketArgs args, InvokeOptions options)
    public static Output<GetUserBucketResult> getUserBucket(GetUserBucketArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ionoscloud:objectstorage/getUserBucket:getUserBucket
      arguments:
        # arguments dictionary
    data "ionoscloud_objectstorage_getuserbucket" "name" {
        # arguments
    }

    The following arguments are supported:

    Name string
    [string] The name of the bucket.
    Region string
    [string] The region where the bucket resides. Valid values: de (Frankfurt), eu-central-2 (Berlin), eu-south-2 (Logroño). Must match the bucket's actual region.
    Name string
    [string] The name of the bucket.
    Region string
    [string] The region where the bucket resides. Valid values: de (Frankfurt), eu-central-2 (Berlin), eu-south-2 (Logroño). Must match the bucket's actual region.
    name string
    [string] The name of the bucket.
    region string
    [string] The region where the bucket resides. Valid values: de (Frankfurt), eu-central-2 (Berlin), eu-south-2 (Logroño). Must match the bucket's actual region.
    name String
    [string] The name of the bucket.
    region String
    [string] The region where the bucket resides. Valid values: de (Frankfurt), eu-central-2 (Berlin), eu-south-2 (Logroño). Must match the bucket's actual region.
    name string
    [string] The name of the bucket.
    region string
    [string] The region where the bucket resides. Valid values: de (Frankfurt), eu-central-2 (Berlin), eu-south-2 (Logroño). Must match the bucket's actual region.
    name str
    [string] The name of the bucket.
    region str
    [string] The region where the bucket resides. Valid values: de (Frankfurt), eu-central-2 (Berlin), eu-south-2 (Logroño). Must match the bucket's actual region.
    name String
    [string] The name of the bucket.
    region String
    [string] The region where the bucket resides. Valid values: de (Frankfurt), eu-central-2 (Berlin), eu-south-2 (Logroño). Must match the bucket's actual region.

    getUserBucket Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the bucket.
    ObjectLockEnabled bool
    Whether Object Lock is enabled for the bucket.
    Region string
    The region of the bucket.
    Tags Dictionary<string, string>
    Tags assigned to the bucket.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the bucket.
    ObjectLockEnabled bool
    Whether Object Lock is enabled for the bucket.
    Region string
    The region of the bucket.
    Tags map[string]string
    Tags assigned to the bucket.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the bucket.
    object_lock_enabled bool
    Whether Object Lock is enabled for the bucket.
    region string
    The region of the bucket.
    tags map(string)
    Tags assigned to the bucket.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the bucket.
    objectLockEnabled Boolean
    Whether Object Lock is enabled for the bucket.
    region String
    The region of the bucket.
    tags Map<String,String>
    Tags assigned to the bucket.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the bucket.
    objectLockEnabled boolean
    Whether Object Lock is enabled for the bucket.
    region string
    The region of the bucket.
    tags {[key: string]: string}
    Tags assigned to the bucket.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the bucket.
    object_lock_enabled bool
    Whether Object Lock is enabled for the bucket.
    region str
    The region of the bucket.
    tags Mapping[str, str]
    Tags assigned to the bucket.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the bucket.
    objectLockEnabled Boolean
    Whether Object Lock is enabled for the bucket.
    region String
    The region of the bucket.
    tags Map<String>
    Tags assigned to the bucket.

    Package Details

    Repository
    ionoscloud ionos-cloud/pulumi-ionoscloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the ionoscloud Terraform Provider.
    ionoscloud logo
    Viewing docs for IonosCloud v0.3.1
    published on Wednesday, Jun 10, 2026 by ionos-cloud

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial