Scaleway v1.25.0, Mar 22 25

Scaleway v1.25.0 published on Saturday, Mar 22, 2025 by pulumiverse

scaleway.object.getBucket

Explore with Pulumi AI

Scaleway v1.25.0 published on Saturday, Mar 22, 2025 by pulumiverse

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 "@pulumi/scaleway";
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 = Pulumi.Scaleway;
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.List;
import java.util.ArrayList;
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}

Retrieve a bucket from a specific project

import * as pulumi from "@pulumi/pulumi";
import * as scaleway from "@pulumi/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 = Pulumi.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.List;
import java.util.ArrayList;
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

Using getBucket

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 getBucket(args: GetBucketArgs, opts?: InvokeOptions): Promise<GetBucketResult>
function getBucketOutput(args: GetBucketOutputArgs, opts?: InvokeOptions): Output<GetBucketResult>

def get_bucket(name: Optional[str] = None,
               project_id: Optional[str] = None,
               region: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetBucketResult
def get_bucket_output(name: Optional[pulumi.Input[str]] = None,
               project_id: Optional[pulumi.Input[str]] = None,
               region: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetBucketResult]

func LookupBucket(ctx *Context, args *LookupBucketArgs, opts ...InvokeOption) (*LookupBucketResult, error)
func LookupBucketOutput(ctx *Context, args *LookupBucketOutputArgs, opts ...InvokeOption) LookupBucketResultOutput

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

public static class GetBucket 
{
    public static Task<GetBucketResult> InvokeAsync(GetBucketArgs args, InvokeOptions? opts = null)
    public static Output<GetBucketResult> Invoke(GetBucketInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetBucketResult> getBucket(GetBucketArgs args, InvokeOptions options)
public static Output<GetBucketResult> getBucket(GetBucketArgs args, InvokeOptions options)

fn::invoke:
  function: scaleway:object/getBucket:getBucket
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string
ProjectId string: project_id) The ID of the project with which the bucket is associated.
Region string: region) The region in which the bucket exists.

Name string
ProjectId string: project_id) The ID of the project with which the bucket is associated.
Region string: region) The region in which the bucket exists.

name String
projectId String: project_id) The ID of the project with which the bucket is associated.
region String: region) The region in which the bucket exists.

name string
projectId string: project_id) The ID of the project with which the bucket is associated.
region string: region) The region in which the bucket exists.

name str
project_id str: project_id) The ID of the project with which the bucket is associated.
region str: region) The region in which the bucket exists.

name String
projectId String: project_id) The ID of the project with which the bucket is associated.
region String: region) The region in which the bucket exists.

getBucket Result

The following output properties are available:

Acl string
ApiEndpoint string
CorsRules List<Pulumiverse.Scaleway.Object.Outputs.GetBucketCorsRule>
Endpoint string: The endpoint URL of the bucket
ForceDestroy bool
Id string: The provider-assigned unique ID for this managed resource.
LifecycleRules List<Pulumiverse.Scaleway.Object.Outputs.GetBucketLifecycleRule>
ObjectLockEnabled bool
Tags Dictionary<string, string>
Versionings List<Pulumiverse.Scaleway.Object.Outputs.GetBucketVersioning>
Name string
ProjectId string
Region string

Acl string
ApiEndpoint string
CorsRules []GetBucketCorsRule
Endpoint string: The endpoint URL of the bucket
ForceDestroy bool
Id string: The provider-assigned unique ID for this managed resource.
LifecycleRules []GetBucketLifecycleRule
ObjectLockEnabled bool
Tags map[string]string
Versionings []GetBucketVersioning
Name string
ProjectId string
Region string

acl String
apiEndpoint String
corsRules List<GetBucketCorsRule>
endpoint String: The endpoint URL of the bucket
forceDestroy Boolean
id String: The provider-assigned unique ID for this managed resource.
lifecycleRules List<GetBucketLifecycleRule>
objectLockEnabled Boolean
tags Map<String,String>
versionings List<GetBucketVersioning>
name String
projectId String
region String

acl string
apiEndpoint string
corsRules GetBucketCorsRule[]
endpoint string: The endpoint URL of the bucket
forceDestroy boolean
id string: The provider-assigned unique ID for this managed resource.
lifecycleRules GetBucketLifecycleRule[]
objectLockEnabled boolean
tags {[key: string]: string}
versionings GetBucketVersioning[]
name string
projectId string
region string

acl str
api_endpoint str
cors_rules Sequence[GetBucketCorsRule]
endpoint str: The endpoint URL of the bucket
force_destroy bool
id str: The provider-assigned unique ID for this managed resource.
lifecycle_rules Sequence[GetBucketLifecycleRule]
object_lock_enabled bool
tags Mapping[str, str]
versionings Sequence[GetBucketVersioning]
name str
project_id str
region str

acl String
apiEndpoint String
corsRules List<Property Map>
endpoint String: The endpoint URL of the bucket
forceDestroy Boolean
id String: The provider-assigned unique ID for this managed resource.
lifecycleRules List<Property Map>
objectLockEnabled Boolean
tags Map<String>
versionings List<Property Map>
name String
projectId String
region String

Supporting Types

GetBucketCorsRule

AllowedHeaders List<string>
AllowedMethods List<string>
AllowedOrigins List<string>
ExposeHeaders List<string>
MaxAgeSeconds int

AllowedHeaders []string
AllowedMethods []string
AllowedOrigins []string
ExposeHeaders []string
MaxAgeSeconds int

allowedHeaders List<String>
allowedMethods List<String>
allowedOrigins List<String>
exposeHeaders List<String>
maxAgeSeconds Integer

allowedHeaders string[]
allowedMethods string[]
allowedOrigins string[]
exposeHeaders string[]
maxAgeSeconds number

allowed_headers Sequence[str]
allowed_methods Sequence[str]
allowed_origins Sequence[str]
expose_headers Sequence[str]
max_age_seconds int

allowedHeaders List<String>
allowedMethods List<String>
allowedOrigins List<String>
exposeHeaders List<String>
maxAgeSeconds Number

GetBucketLifecycleRule

AbortIncompleteMultipartUploadDays int: Specifies the number of days after initiating a multipart upload when the multipart upload must be completed
Enabled bool: Specifies if the configuration rule is Enabled or Disabled
Expirations List<Pulumiverse.Scaleway.Object.Inputs.GetBucketLifecycleRuleExpiration>: Specifies a period in the object's expire
Id string: The unique identifier of the bucket.
Prefix string: The prefix identifying one or more objects to which the rule applies
Tags Dictionary<string, string>: The tags associated with the bucket lifecycle
Transitions List<Pulumiverse.Scaleway.Object.Inputs.GetBucketLifecycleRuleTransition>: Define when objects transition to another storage class

AbortIncompleteMultipartUploadDays int: Specifies the number of days after initiating a multipart upload when the multipart upload must be completed
Enabled bool: Specifies if the configuration rule is Enabled or Disabled
Expirations []GetBucketLifecycleRuleExpiration: Specifies a period in the object's expire
Id string: The unique identifier of the bucket.
Prefix string: The prefix identifying one or more objects to which the rule applies
Tags map[string]string: The tags associated with the bucket lifecycle
Transitions []GetBucketLifecycleRuleTransition: Define when objects transition to another storage class

abortIncompleteMultipartUploadDays Integer: Specifies the number of days after initiating a multipart upload when the multipart upload must be completed
enabled Boolean: Specifies if the configuration rule is Enabled or Disabled
expirations List<GetBucketLifecycleRuleExpiration>: Specifies a period in the object's expire
id String: The unique identifier of the bucket.
prefix String: The prefix identifying one or more objects to which the rule applies
tags Map<String,String>: The tags associated with the bucket lifecycle
transitions List<GetBucketLifecycleRuleTransition>: Define when objects transition to another storage class

abortIncompleteMultipartUploadDays number: Specifies the number of days after initiating a multipart upload when the multipart upload must be completed
enabled boolean: Specifies if the configuration rule is Enabled or Disabled
expirations GetBucketLifecycleRuleExpiration[]: Specifies a period in the object's expire
id string: The unique identifier of the bucket.
prefix string: The prefix identifying one or more objects to which the rule applies
tags {[key: string]: string}: The tags associated with the bucket lifecycle
transitions GetBucketLifecycleRuleTransition[]: Define when objects transition to another storage class

abort_incomplete_multipart_upload_days int: Specifies the number of days after initiating a multipart upload when the multipart upload must be completed
enabled bool: Specifies if the configuration rule is Enabled or Disabled
expirations Sequence[GetBucketLifecycleRuleExpiration]: Specifies a period in the object's expire
id str: The unique identifier of the bucket.
prefix str: The prefix identifying one or more objects to which the rule applies
tags Mapping[str, str]: The tags associated with the bucket lifecycle
transitions Sequence[GetBucketLifecycleRuleTransition]: Define when objects transition to another storage class

abortIncompleteMultipartUploadDays Number: Specifies the number of days after initiating a multipart upload when the multipart upload must be completed
enabled Boolean: Specifies if the configuration rule is Enabled or Disabled
expirations List<Property Map>: Specifies a period in the object's expire
id String: The unique identifier of the bucket.
prefix String: The prefix identifying one or more objects to which the rule applies
tags Map<String>: The tags associated with the bucket lifecycle
transitions List<Property Map>: Define when objects transition to another storage class

GetBucketLifecycleRuleExpiration

Days int: Specifies the number of days after object creation when the specific rule action takes effect

Days int: Specifies the number of days after object creation when the specific rule action takes effect

days Integer: Specifies the number of days after object creation when the specific rule action takes effect

days number: Specifies the number of days after object creation when the specific rule action takes effect

days int: Specifies the number of days after object creation when the specific rule action takes effect

days Number: Specifies the number of days after object creation when the specific rule action takes effect

GetBucketLifecycleRuleTransition

Days int: Specifies the number of days after object creation when the specific rule action takes effect
StorageClass string: Specifies the Scaleway Object Storage class to which you want the object to transition

Days int: Specifies the number of days after object creation when the specific rule action takes effect
StorageClass string: Specifies the Scaleway Object Storage class to which you want the object to transition

days Integer: Specifies the number of days after object creation when the specific rule action takes effect
storageClass String: Specifies the Scaleway Object Storage class to which you want the object to transition

days number: Specifies the number of days after object creation when the specific rule action takes effect
storageClass string: Specifies the Scaleway Object Storage class to which you want the object to transition

days int: Specifies the number of days after object creation when the specific rule action takes effect
storage_class str: Specifies the Scaleway Object Storage class to which you want the object to transition

days Number: Specifies the number of days after object creation when the specific rule action takes effect
storageClass String: Specifies the Scaleway Object Storage class to which you want the object to transition

GetBucketVersioning

Enabled bool: Enable versioning. Once you version-enable a bucket, it can never return to an unversioned state

Enabled bool: Enable versioning. Once you version-enable a bucket, it can never return to an unversioned state

enabled Boolean: Enable versioning. Once you version-enable a bucket, it can never return to an unversioned state

enabled boolean: Enable versioning. Once you version-enable a bucket, it can never return to an unversioned state

enabled bool: Enable versioning. Once you version-enable a bucket, it can never return to an unversioned state

enabled Boolean: Enable versioning. Once you version-enable a bucket, it can never return to an unversioned state

Package Details

Repository: scaleway pulumiverse/pulumi-scaleway
License: Apache-2.0
Notes: This Pulumi package is based on the scaleway Terraform Provider.

Scaleway v1.25.0 published on Saturday, Mar 22, 2025 by pulumiverse

pulumiverse/pulumi-scaleway

scaleway.object.getBucket

On this page

On this page

Retrieve an Object Storage bucket

Retrieve a bucket from a specific project

Using getBucket

getBucket Result

Supporting Types

GetBucketCorsRule

GetBucketLifecycleRule

GetBucketLifecycleRuleExpiration

GetBucketLifecycleRuleTransition

GetBucketVersioning

Package Details

On this page

On this page