1. Packages
  2. Volcengine
  3. API Docs
  4. tos
  5. getBuckets
Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

volcengine.tos.getBuckets

volcengine logo
Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

    Use this data source to query detailed information of tos buckets

    Example Usage

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

const default = volcengine.tos.getBuckets({
    nameRegex: "test",
});

    import pulumi
import pulumi_volcengine as volcengine

default = volcengine.tos.get_buckets(name_regex="test")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/tos"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tos.GetBuckets(ctx, &tos.GetBucketsArgs{
			NameRegex: pulumi.StringRef("test"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var @default = Volcengine.Tos.GetBuckets.Invoke(new()
    {
        NameRegex = "test",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.tos.TosFunctions;
import com.pulumi.volcengine.tos.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 default = TosFunctions.getBuckets(GetBucketsArgs.builder()
            .nameRegex("test")
            .build());

    }
}

    variables:
  default:
    fn::invoke:
      Function: volcengine:tos:getBuckets
      Arguments:
        nameRegex: test

    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(bucket_name: Optional[str] = None,
                name_regex: Optional[str] = None,
                output_file: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetBucketsResult
def get_buckets_output(bucket_name: Optional[pulumi.Input[str]] = None,
                name_regex: Optional[pulumi.Input[str]] = None,
                output_file: 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: volcengine:tos/getBuckets:getBuckets
  arguments:
    # arguments dictionary

    The following arguments are supported:

    BucketName string
    The name the TOS bucket.
    NameRegex string
    A Name Regex of TOS bucket.
    OutputFile string
    File name where to save data source results.
    BucketName string
    The name the TOS bucket.
    NameRegex string
    A Name Regex of TOS bucket.
    OutputFile string
    File name where to save data source results.
    bucketName String
    The name the TOS bucket.
    nameRegex String
    A Name Regex of TOS bucket.
    outputFile String
    File name where to save data source results.
    bucketName string
    The name the TOS bucket.
    nameRegex string
    A Name Regex of TOS bucket.
    outputFile string
    File name where to save data source results.
    bucket_name str
    The name the TOS bucket.
    name_regex str
    A Name Regex of TOS bucket.
    output_file str
    File name where to save data source results.
    bucketName String
    The name the TOS bucket.
    nameRegex String
    A Name Regex of TOS bucket.
    outputFile String
    File name where to save data source results.

    getBuckets Result

    The following output properties are available:

    Buckets List<GetBucketsBucket>
    The collection of TOS bucket query.
    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCount int
    The total count of TOS bucket query.
    BucketName string
    NameRegex string
    OutputFile string
    Buckets []GetBucketsBucket
    The collection of TOS bucket query.
    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCount int
    The total count of TOS bucket query.
    BucketName string
    NameRegex string
    OutputFile string
    buckets List<GetBucketsBucket>
    The collection of TOS bucket query.
    id String
    The provider-assigned unique ID for this managed resource.
    totalCount Integer
    The total count of TOS bucket query.
    bucketName String
    nameRegex String
    outputFile String
    buckets GetBucketsBucket[]
    The collection of TOS bucket query.
    id string
    The provider-assigned unique ID for this managed resource.
    totalCount number
    The total count of TOS bucket query.
    bucketName string
    nameRegex string
    outputFile string
    buckets Sequence[GetBucketsBucket]
    The collection of TOS bucket query.
    id str
    The provider-assigned unique ID for this managed resource.
    total_count int
    The total count of TOS bucket query.
    bucket_name str
    name_regex str
    output_file str
    buckets List<Property Map>
    The collection of TOS bucket query.
    id String
    The provider-assigned unique ID for this managed resource.
    totalCount Number
    The total count of TOS bucket query.
    bucketName String
    nameRegex String
    outputFile String

    Supporting Types

    GetBucketsBucket

    CreationDate string
    The create date of the TOS bucket.
    ExtranetEndpoint string
    The extranet endpoint of the TOS bucket.
    IntranetEndpoint string
    The intranet endpoint the TOS bucket.
    IsTruncated bool
    (Deprecated) The Field is Deprecated. The truncated the TOS bucket.

    Deprecated: The Field is Deprecated.

    Location string
    The location of the TOS bucket.
    Marker string
    (Deprecated) The Field is Deprecated. The marker the TOS bucket.

    Deprecated: The Field is Deprecated.

    MaxKeys int
    (Deprecated) The Field is Deprecated. The max keys the TOS bucket.

    Deprecated: The Field is Deprecated.

    Name string
    The name the TOS bucket.
    Prefix string
    (Deprecated) The Field is Deprecated. The prefix the TOS bucket.

    Deprecated: The Field is Deprecated.

    CreationDate string
    The create date of the TOS bucket.
    ExtranetEndpoint string
    The extranet endpoint of the TOS bucket.
    IntranetEndpoint string
    The intranet endpoint the TOS bucket.
    IsTruncated bool
    (Deprecated) The Field is Deprecated. The truncated the TOS bucket.

    Deprecated: The Field is Deprecated.

    Location string
    The location of the TOS bucket.
    Marker string
    (Deprecated) The Field is Deprecated. The marker the TOS bucket.

    Deprecated: The Field is Deprecated.

    MaxKeys int
    (Deprecated) The Field is Deprecated. The max keys the TOS bucket.

    Deprecated: The Field is Deprecated.

    Name string
    The name the TOS bucket.
    Prefix string
    (Deprecated) The Field is Deprecated. The prefix the TOS bucket.

    Deprecated: The Field is Deprecated.

    creationDate String
    The create date of the TOS bucket.
    extranetEndpoint String
    The extranet endpoint of the TOS bucket.
    intranetEndpoint String
    The intranet endpoint the TOS bucket.
    isTruncated Boolean
    (Deprecated) The Field is Deprecated. The truncated the TOS bucket.

    Deprecated: The Field is Deprecated.

    location String
    The location of the TOS bucket.
    marker String
    (Deprecated) The Field is Deprecated. The marker the TOS bucket.

    Deprecated: The Field is Deprecated.

    maxKeys Integer
    (Deprecated) The Field is Deprecated. The max keys the TOS bucket.

    Deprecated: The Field is Deprecated.

    name String
    The name the TOS bucket.
    prefix String
    (Deprecated) The Field is Deprecated. The prefix the TOS bucket.

    Deprecated: The Field is Deprecated.

    creationDate string
    The create date of the TOS bucket.
    extranetEndpoint string
    The extranet endpoint of the TOS bucket.
    intranetEndpoint string
    The intranet endpoint the TOS bucket.
    isTruncated boolean
    (Deprecated) The Field is Deprecated. The truncated the TOS bucket.

    Deprecated: The Field is Deprecated.

    location string
    The location of the TOS bucket.
    marker string
    (Deprecated) The Field is Deprecated. The marker the TOS bucket.

    Deprecated: The Field is Deprecated.

    maxKeys number
    (Deprecated) The Field is Deprecated. The max keys the TOS bucket.

    Deprecated: The Field is Deprecated.

    name string
    The name the TOS bucket.
    prefix string
    (Deprecated) The Field is Deprecated. The prefix the TOS bucket.

    Deprecated: The Field is Deprecated.

    creation_date str
    The create date of the TOS bucket.
    extranet_endpoint str
    The extranet endpoint of the TOS bucket.
    intranet_endpoint str
    The intranet endpoint the TOS bucket.
    is_truncated bool
    (Deprecated) The Field is Deprecated. The truncated the TOS bucket.

    Deprecated: The Field is Deprecated.

    location str
    The location of the TOS bucket.
    marker str
    (Deprecated) The Field is Deprecated. The marker the TOS bucket.

    Deprecated: The Field is Deprecated.

    max_keys int
    (Deprecated) The Field is Deprecated. The max keys the TOS bucket.

    Deprecated: The Field is Deprecated.

    name str
    The name the TOS bucket.
    prefix str
    (Deprecated) The Field is Deprecated. The prefix the TOS bucket.

    Deprecated: The Field is Deprecated.

    creationDate String
    The create date of the TOS bucket.
    extranetEndpoint String
    The extranet endpoint of the TOS bucket.
    intranetEndpoint String
    The intranet endpoint the TOS bucket.
    isTruncated Boolean
    (Deprecated) The Field is Deprecated. The truncated the TOS bucket.

    Deprecated: The Field is Deprecated.

    location String
    The location of the TOS bucket.
    marker String
    (Deprecated) The Field is Deprecated. The marker the TOS bucket.

    Deprecated: The Field is Deprecated.

    maxKeys Number
    (Deprecated) The Field is Deprecated. The max keys the TOS bucket.

    Deprecated: The Field is Deprecated.

    name String
    The name the TOS bucket.
    prefix String
    (Deprecated) The Field is Deprecated. The prefix the TOS bucket.

    Deprecated: The Field is Deprecated.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcengine
      Meet Neo: Your AI Platform Teammate