getBuckets

Gets a list of existing GCS buckets. See the official documentation and API.

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")
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 main
import (
"github.com/pulumi/pulumi-gcp/sdk/v7/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
})
}
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

Return

A collection of values returned by getBuckets.

Parameters

argument

A collection of arguments for invoking getBuckets.


suspend fun getBuckets(prefix: String? = null, project: String? = null): GetBucketsResult

Return

A collection of values returned by getBuckets.

Parameters

prefix

Filter results to buckets whose names begin with this prefix.

project

The ID of the project. If it is not provided, the provider project is used.

See also


suspend fun getBuckets(argument: suspend GetBucketsPlainArgsBuilder.() -> Unit): GetBucketsResult

Return

A collection of values returned by getBuckets.

Parameters

argument

Builder for com.pulumi.gcp.storage.kotlin.inputs.GetBucketsPlainArgs.

See also