1. Packages
  2. Volcengine
  3. API Docs
  4. tos
  5. Buckets
Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine

volcengine.tos.Buckets

Explore with Pulumi AI

Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by 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.Buckets({
    nameRegex: "test",
});
Copy
import pulumi
import pulumi_volcengine as volcengine

default = volcengine.tos.buckets(name_regex="test")
Copy
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.Buckets(ctx, &tos.BucketsArgs{
			NameRegex: pulumi.StringRef("test"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;

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

});
Copy
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.BucketsArgs;
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.Buckets(BucketsArgs.builder()
            .nameRegex("test")
            .build());

    }
}
Copy
variables:
  default:
    fn::invoke:
      Function: volcengine:tos:Buckets
      Arguments:
        nameRegex: test
Copy

Using Buckets

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 buckets(args: BucketsArgs, opts?: InvokeOptions): Promise<BucketsResult>
function bucketsOutput(args: BucketsOutputArgs, opts?: InvokeOptions): Output<BucketsResult>
Copy
def buckets(bucket_name: Optional[str] = None,
            name_regex: Optional[str] = None,
            output_file: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> BucketsResult
def 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[BucketsResult]
Copy
func Buckets(ctx *Context, args *BucketsArgs, opts ...InvokeOption) (*BucketsResult, error)
func BucketsOutput(ctx *Context, args *BucketsOutputArgs, opts ...InvokeOption) BucketsResultOutput
Copy
public static class Buckets 
{
    public static Task<BucketsResult> InvokeAsync(BucketsArgs args, InvokeOptions? opts = null)
    public static Output<BucketsResult> Invoke(BucketsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<BucketsResult> buckets(BucketsArgs args, InvokeOptions options)
public static Output<BucketsResult> buckets(BucketsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: volcengine:tos:Buckets
  arguments:
    # arguments dictionary
Copy

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.

Buckets Result

The following output properties are available:

Buckets List<BucketsBucket>
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 []BucketsBucket
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<BucketsBucket>
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 BucketsBucket[]
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[BucketsBucket]
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

BucketsBucket

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

Deprecated: The Field is Deprecated.

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

Deprecated: The Field is Deprecated.

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

Deprecated: The Field is Deprecated.

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

Deprecated: The Field is Deprecated.

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

Deprecated: The Field is Deprecated.

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

Deprecated: The Field is Deprecated.

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

Deprecated: The Field is Deprecated.

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

Deprecated: The Field is Deprecated.

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

Deprecated: The Field is Deprecated.

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

Deprecated: The Field is Deprecated.

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

Deprecated: The Field is Deprecated.

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

Deprecated: The Field is Deprecated.

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

Deprecated: The Field is Deprecated.

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

Deprecated: The Field is Deprecated.

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

Deprecated: The Field is Deprecated.

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

Deprecated: The Field is Deprecated.

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

Deprecated: The Field is Deprecated.

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

Deprecated: The Field is Deprecated.

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

Deprecated: The Field is Deprecated.

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

Deprecated: The Field is Deprecated.

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

Deprecated: The Field is Deprecated.

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

Deprecated: The Field is Deprecated.

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

Deprecated: The Field is Deprecated.

name This property is required. String
The name the TOS bucket.
prefix This property is required. 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 v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine