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 logo
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",
    });
    
    import pulumi
    import pulumi_volcengine as volcengine
    
    default = volcengine.tos.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.Buckets(ctx, &tos.BucketsArgs{
    			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.Buckets.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.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());
    
        }
    }
    
    variables:
      default:
        fn::invoke:
          Function: volcengine:tos:Buckets
          Arguments:
            nameRegex: test
    

    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>
    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]
    func Buckets(ctx *Context, args *BucketsArgs, opts ...InvokeOption) (*BucketsResult, error)
    func BucketsOutput(ctx *Context, args *BucketsOutputArgs, opts ...InvokeOption) BucketsResultOutput
    public static class Buckets 
    {
        public static Task<BucketsResult> InvokeAsync(BucketsArgs args, InvokeOptions? opts = null)
        public static Output<BucketsResult> Invoke(BucketsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<BucketsResult> buckets(BucketsArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: volcengine:tos:Buckets
      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.

    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 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.27 published on Tuesday, Dec 10, 2024 by Volcengine