getBuckets

Google Cloud v9.15.0, Mar 12 26

Viewing docs for Google Cloud v9.15.0
published on Thursday, Mar 12, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-gcp

Viewing docs for Google Cloud v9.15.0
published on Thursday, Mar 12, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-gcp

Example Usage

Example GCS buckets.

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const example = gcp.storage.getBuckets({
    project: "example-project",
});

import pulumi
import pulumi_gcp as gcp

example = gcp.storage.get_buckets(project="example-project")

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/storage"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := storage.GetBuckets(ctx, &storage.GetBucketsArgs{
			Project: pulumi.StringRef("example-project"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var example = Gcp.Storage.GetBuckets.Invoke(new()
    {
        Project = "example-project",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.storage.StorageFunctions;
import com.pulumi.gcp.storage.inputs.GetBucketsArgs;
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 example = StorageFunctions.getBuckets(GetBucketsArgs.builder()
            .project("example-project")
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: gcp:storage:getBuckets
      arguments:
        project: example-project

Using getBuckets

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 getBuckets(args: GetBucketsArgs, opts?: InvokeOptions): Promise<GetBucketsResult>
function getBucketsOutput(args: GetBucketsOutputArgs, opts?: InvokeOptions): Output<GetBucketsResult>

def get_buckets(prefix: Optional[str] = None,
                project: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetBucketsResult
def get_buckets_output(prefix: Optional[pulumi.Input[str]] = None,
                project: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetBucketsResult]

func GetBuckets(ctx *Context, args *GetBucketsArgs, opts ...InvokeOption) (*GetBucketsResult, error)
func GetBucketsOutput(ctx *Context, args *GetBucketsOutputArgs, opts ...InvokeOption) GetBucketsResultOutput

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

public static class GetBuckets 
{
    public static Task<GetBucketsResult> InvokeAsync(GetBucketsArgs args, InvokeOptions? opts = null)
    public static Output<GetBucketsResult> Invoke(GetBucketsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetBucketsResult> getBuckets(GetBucketsArgs args, InvokeOptions options)
public static Output<GetBucketsResult> getBuckets(GetBucketsArgs args, InvokeOptions options)

fn::invoke:
  function: gcp:storage/getBuckets:getBuckets
  arguments:
    # arguments dictionary

The following arguments are supported:

Prefix string: Filter results to buckets whose names begin with this prefix.
Project string: The ID of the project. If it is not provided, the provider project is used.

Prefix string: Filter results to buckets whose names begin with this prefix.
Project string: The ID of the project. If it is not provided, the provider project is used.

prefix String: Filter results to buckets whose names begin with this prefix.
project String: The ID of the project. If it is not provided, the provider project is used.

prefix string: Filter results to buckets whose names begin with this prefix.
project string: The ID of the project. If it is not provided, the provider project is used.

prefix str: Filter results to buckets whose names begin with this prefix.
project str: The ID of the project. If it is not provided, the provider project is used.

prefix String: Filter results to buckets whose names begin with this prefix.
project String: The ID of the project. If it is not provided, the provider project is used.

getBuckets Result

The following output properties are available:

Buckets List<GetBucketsBucket>: A list of all retrieved GCS buckets. Structure is defined below.
Id string: The provider-assigned unique ID for this managed resource.
Prefix string
Project string

Buckets []GetBucketsBucket: A list of all retrieved GCS buckets. Structure is defined below.
Id string: The provider-assigned unique ID for this managed resource.
Prefix string
Project string

buckets List<GetBucketsBucket>: A list of all retrieved GCS buckets. Structure is defined below.
id String: The provider-assigned unique ID for this managed resource.
prefix String
project String

buckets GetBucketsBucket[]: A list of all retrieved GCS buckets. Structure is defined below.
id string: The provider-assigned unique ID for this managed resource.
prefix string
project string

buckets Sequence[GetBucketsBucket]: A list of all retrieved GCS buckets. Structure is defined below.
id str: The provider-assigned unique ID for this managed resource.
prefix str
project str

buckets List<Property Map>: A list of all retrieved GCS buckets. Structure is defined below.
id String: The provider-assigned unique ID for this managed resource.
prefix String
project String

Supporting Types

GetBucketsBucket

Labels Dictionary<string, string>: User-provided bucket labels, in key/value pairs.
Location string: The location of the bucket.
Name string: The name of the bucket.
SelfLink string: A url reference to the bucket.
StorageClass string: The StorageClass of the bucket.

Labels map[string]string: User-provided bucket labels, in key/value pairs.
Location string: The location of the bucket.
Name string: The name of the bucket.
SelfLink string: A url reference to the bucket.
StorageClass string: The StorageClass of the bucket.

labels Map<String,String>: User-provided bucket labels, in key/value pairs.
location String: The location of the bucket.
name String: The name of the bucket.
selfLink String: A url reference to the bucket.
storageClass String: The StorageClass of the bucket.

labels {[key: string]: string}: User-provided bucket labels, in key/value pairs.
location string: The location of the bucket.
name string: The name of the bucket.
selfLink string: A url reference to the bucket.
storageClass string: The StorageClass of the bucket.

labels Mapping[str, str]: User-provided bucket labels, in key/value pairs.
location str: The location of the bucket.
name str: The name of the bucket.
self_link str: A url reference to the bucket.
storage_class str: The StorageClass of the bucket.