Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Volcengine
  3. API Docs
  4. tos
  5. BucketObjects
Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
volcengine/pulumi-volcengine

volcengine.tos.BucketObjects

Explore with Pulumi AI

Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
volcengine/pulumi-volcengine

Use this data source to query detailed information of tos objects

Example Usage

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

const default = volcengine.tos.BucketObjects({
    bucketName: "test",
});
Copy
import pulumi
import pulumi_volcengine as volcengine

default = volcengine.tos.bucket_objects(bucket_name="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.BucketObjects(ctx, &tos.BucketObjectsArgs{
			BucketName: "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.BucketObjects.Invoke(new()
    {
        BucketName = "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.BucketObjectsArgs;
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.BucketObjects(BucketObjectsArgs.builder()
            .bucketName("test")
            .build());

    }
}
Copy
variables:
  default:
    fn::invoke:
      Function: volcengine:tos:BucketObjects
      Arguments:
        bucketName: test
Copy

Using BucketObjects

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 bucketObjects(args: BucketObjectsArgs, opts?: InvokeOptions): Promise<BucketObjectsResult>
function bucketObjectsOutput(args: BucketObjectsOutputArgs, opts?: InvokeOptions): Output<BucketObjectsResult>
Copy
def bucket_objects(bucket_name: Optional[str] = None,
                   name_regex: Optional[str] = None,
                   object_name: Optional[str] = None,
                   output_file: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> BucketObjectsResult
def bucket_objects_output(bucket_name: Optional[pulumi.Input[str]] = None,
                   name_regex: Optional[pulumi.Input[str]] = None,
                   object_name: Optional[pulumi.Input[str]] = None,
                   output_file: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[BucketObjectsResult]
Copy
func BucketObjects(ctx *Context, args *BucketObjectsArgs, opts ...InvokeOption) (*BucketObjectsResult, error)
func BucketObjectsOutput(ctx *Context, args *BucketObjectsOutputArgs, opts ...InvokeOption) BucketObjectsResultOutput
Copy
public static class BucketObjects 
{
    public static Task<BucketObjectsResult> InvokeAsync(BucketObjectsArgs args, InvokeOptions? opts = null)
    public static Output<BucketObjectsResult> Invoke(BucketObjectsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<BucketObjectsResult> bucketObjects(BucketObjectsArgs args, InvokeOptions options)
public static Output<BucketObjectsResult> bucketObjects(BucketObjectsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: volcengine:tos:BucketObjects
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

BucketName This property is required. string
The name the TOS bucket.
NameRegex string
A Name Regex of TOS Object.
ObjectName string
The name the TOS Object.
OutputFile string
File name where to save data source results.
BucketName This property is required. string
The name the TOS bucket.
NameRegex string
A Name Regex of TOS Object.
ObjectName string
The name the TOS Object.
OutputFile string
File name where to save data source results.
bucketName This property is required. String
The name the TOS bucket.
nameRegex String
A Name Regex of TOS Object.
objectName String
The name the TOS Object.
outputFile String
File name where to save data source results.
bucketName This property is required. string
The name the TOS bucket.
nameRegex string
A Name Regex of TOS Object.
objectName string
The name the TOS Object.
outputFile string
File name where to save data source results.
bucket_name This property is required. str
The name the TOS bucket.
name_regex str
A Name Regex of TOS Object.
object_name str
The name the TOS Object.
output_file str
File name where to save data source results.
bucketName This property is required. String
The name the TOS bucket.
nameRegex String
A Name Regex of TOS Object.
objectName String
The name the TOS Object.
outputFile String
File name where to save data source results.

BucketObjects Result

The following output properties are available:

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

Supporting Types

BucketObjectsObject

Content This property is required. string
The content the TOS Object when content type is json or text and xml.
Name This property is required. string
The name the TOS Object.
Size This property is required. int
The name the TOS Object size.
StorageClass This property is required. string
The name the TOS Object storage class.
Content This property is required. string
The content the TOS Object when content type is json or text and xml.
Name This property is required. string
The name the TOS Object.
Size This property is required. int
The name the TOS Object size.
StorageClass This property is required. string
The name the TOS Object storage class.
content This property is required. String
The content the TOS Object when content type is json or text and xml.
name This property is required. String
The name the TOS Object.
size This property is required. Integer
The name the TOS Object size.
storageClass This property is required. String
The name the TOS Object storage class.
content This property is required. string
The content the TOS Object when content type is json or text and xml.
name This property is required. string
The name the TOS Object.
size This property is required. number
The name the TOS Object size.
storageClass This property is required. string
The name the TOS Object storage class.
content This property is required. str
The content the TOS Object when content type is json or text and xml.
name This property is required. str
The name the TOS Object.
size This property is required. int
The name the TOS Object size.
storage_class This property is required. str
The name the TOS Object storage class.
content This property is required. String
The content the TOS Object when content type is json or text and xml.
name This property is required. String
The name the TOS Object.
size This property is required. Number
The name the TOS Object size.
storageClass This property is required. String
The name the TOS Object storage class.

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
volcengine/pulumi-volcengine