getObjectBucket

Scaleway v1.50.1, Jun 17 26

Viewing docs for Scaleway v1.50.1
published on Wednesday, Jun 17, 2026 by pulumiverse

Schema (JSON)

pulumiverse/pulumi-scaleway

Viewing docs for Scaleway v1.50.1
published on Wednesday, Jun 17, 2026 by pulumiverse

Schema (JSON)

pulumiverse/pulumi-scaleway

Retrieve an Object Storage bucket

The following commands allow you to:

retrieve a bucket by its name
retrieve a bucket by its ID

import * as pulumi from "@pulumi/pulumi";
import * as scaleway from "@pulumiverse/scaleway";

const main = new scaleway.object.Bucket("main", {
    name: "bucket.test.com",
    tags: {
        foo: "bar",
    },
});
const selected = scaleway.object.getBucketOutput({
    name: main.id,
});

import pulumi
import pulumi_scaleway as scaleway
import pulumiverse_scaleway as scaleway

main = scaleway.object.Bucket("main",
    name="bucket.test.com",
    tags={
        "foo": "bar",
    })
selected = scaleway.object.get_bucket_output(name=main.id)

package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway/object"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		main, err := object.NewBucket(ctx, "main", &object.BucketArgs{
			Name: pulumi.String("bucket.test.com"),
			Tags: pulumi.StringMap{
				"foo": pulumi.String("bar"),
			},
		})
		if err != nil {
			return err
		}
		_ = object.LookupBucketOutput(ctx, object.GetBucketOutputArgs{
			Name: main.ID(),
		}, nil)
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scaleway = Pulumiverse.Scaleway;

return await Deployment.RunAsync(() => 
{
    var main = new Scaleway.Object.Bucket("main", new()
    {
        Name = "bucket.test.com",
        Tags = 
        {
            { "foo", "bar" },
        },
    });

    var selected = Scaleway.Object.GetBucket.Invoke(new()
    {
        Name = main.Id,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scaleway.object.Bucket;
import com.pulumi.scaleway.object.BucketArgs;
import com.pulumi.scaleway.object.ObjectFunctions;
import com.pulumi.scaleway.object.inputs.GetBucketArgs;
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) {
        var main = new Bucket("main", BucketArgs.builder()
            .name("bucket.test.com")
            .tags(Map.of("foo", "bar"))
            .build());

        final var selected = ObjectFunctions.getBucket(GetBucketArgs.builder()
            .name(main.id())
            .build());

    }
}

resources:
  main:
    type: scaleway:object:Bucket
    properties:
      name: bucket.test.com
      tags:
        foo: bar
variables:
  selected:
    fn::invoke:
      function: scaleway:object:getBucket
      arguments:
        name: ${main.id}

Example coming soon!

Retrieve a bucket from a specific project

import * as pulumi from "@pulumi/pulumi";
import * as scaleway from "@pulumiverse/scaleway";

const selected = scaleway.object.getBucket({
    name: "bucket.test.com",
    projectId: "11111111-1111-1111-1111-111111111111",
});

import pulumi
import pulumi_scaleway as scaleway

selected = scaleway.object.get_bucket(name="bucket.test.com",
    project_id="11111111-1111-1111-1111-111111111111")

package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway/object"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := object.LookupBucket(ctx, &object.LookupBucketArgs{
			Name:      pulumi.StringRef("bucket.test.com"),
			ProjectId: pulumi.StringRef("11111111-1111-1111-1111-111111111111"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scaleway = Pulumiverse.Scaleway;

return await Deployment.RunAsync(() => 
{
    var selected = Scaleway.Object.GetBucket.Invoke(new()
    {
        Name = "bucket.test.com",
        ProjectId = "11111111-1111-1111-1111-111111111111",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scaleway.object.ObjectFunctions;
import com.pulumi.scaleway.object.inputs.GetBucketArgs;
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 selected = ObjectFunctions.getBucket(GetBucketArgs.builder()
            .name("bucket.test.com")
            .projectId("11111111-1111-1111-1111-111111111111")
            .build());

    }
}

variables:
  selected:
    fn::invoke:
      function: scaleway:object:getBucket
      arguments:
        name: bucket.test.com
        projectId: 11111111-1111-1111-1111-111111111111

Example coming soon!

Using getObjectBucket

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 getObjectBucket(args: GetObjectBucketArgs, opts?: InvokeOptions): Promise<GetObjectBucketResult>
function getObjectBucketOutput(args: GetObjectBucketOutputArgs, opts?: InvokeOptions): Output<GetObjectBucketResult>

def get_object_bucket(name: Optional[str] = None,
                      project_id: Optional[str] = None,
                      region: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetObjectBucketResult
def get_object_bucket_output(name: pulumi.Input[Optional[str]] = None,
                      project_id: pulumi.Input[Optional[str]] = None,
                      region: pulumi.Input[Optional[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetObjectBucketResult]

func LookupObjectBucket(ctx *Context, args *LookupObjectBucketArgs, opts ...InvokeOption) (*LookupObjectBucketResult, error)
func LookupObjectBucketOutput(ctx *Context, args *LookupObjectBucketOutputArgs, opts ...InvokeOption) LookupObjectBucketResultOutput

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

public static class GetObjectBucket 
{
    public static Task<GetObjectBucketResult> InvokeAsync(GetObjectBucketArgs args, InvokeOptions? opts = null)
    public static Output<GetObjectBucketResult> Invoke(GetObjectBucketInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetObjectBucketResult> getObjectBucket(GetObjectBucketArgs args, InvokeOptions options)
public static Output<GetObjectBucketResult> getObjectBucket(GetObjectBucketArgs args, InvokeOptions options)

fn::invoke:
  function: scaleway:index/getObjectBucket:getObjectBucket
  arguments:
    # arguments dictionary

data "scaleway_getobjectbucket" "name" {
    # arguments
}

The following arguments are supported:

Name string: The name of the bucket, or its terraform ID ({region}/{name})
ProjectId string: projectId) The ID of the project with which the bucket is associated.
Region string: region) The region in which the bucket exists.

Name string: The name of the bucket, or its terraform ID ({region}/{name})
ProjectId string: projectId) The ID of the project with which the bucket is associated.
Region string: region) The region in which the bucket exists.

name string: The name of the bucket, or its terraform ID ({region}/{name})
project_id string: projectId) The ID of the project with which the bucket is associated.
region string: region) The region in which the bucket exists.

name String: The name of the bucket, or its terraform ID ({region}/{name})
projectId String: projectId) The ID of the project with which the bucket is associated.
region String: region) The region in which the bucket exists.

name string: The name of the bucket, or its terraform ID ({region}/{name})
projectId string: projectId) The ID of the project with which the bucket is associated.
region string: region) The region in which the bucket exists.

name str: The name of the bucket, or its terraform ID ({region}/{name})
project_id str: projectId) The ID of the project with which the bucket is associated.
region str: region) The region in which the bucket exists.

name String: The name of the bucket, or its terraform ID ({region}/{name})
projectId String: projectId) The ID of the project with which the bucket is associated.
region String: region) The region in which the bucket exists.