get Bucket Objects
This data source provides the objects of an OSS bucket.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const bucketObjectsDs = alicloud.oss.getBucketObjects({
bucketName: "sample_bucket",
keyRegex: "sample/sample_object.txt",
});
export const firstObjectKey = bucketObjectsDs.then(bucketObjectsDs => bucketObjectsDs.objects?.[0]?.key);
Content copied to clipboard
import pulumi
import pulumi_alicloud as alicloud
bucket_objects_ds = alicloud.oss.get_bucket_objects(bucket_name="sample_bucket",
key_regex="sample/sample_object.txt")
pulumi.export("firstObjectKey", bucket_objects_ds.objects[0].key)
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;
return await Deployment.RunAsync(() =>
{
var bucketObjectsDs = AliCloud.Oss.GetBucketObjects.Invoke(new()
{
BucketName = "sample_bucket",
KeyRegex = "sample/sample_object.txt",
});
return new Dictionary<string, object?>
{
["firstObjectKey"] = bucketObjectsDs.Apply(getBucketObjectsResult => getBucketObjectsResult.Objects[0]?.Key),
};
});
Content copied to clipboard
package main
import (
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/oss"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
bucketObjectsDs, err := oss.GetBucketObjects(ctx, &oss.GetBucketObjectsArgs{
BucketName: "sample_bucket",
KeyRegex: pulumi.StringRef("sample/sample_object.txt"),
}, nil)
if err != nil {
return err
}
ctx.Export("firstObjectKey", bucketObjectsDs.Objects[0].Key)
return nil
})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.oss.OssFunctions;
import com.pulumi.alicloud.oss.inputs.GetBucketObjectsArgs;
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 bucketObjectsDs = OssFunctions.getBucketObjects(GetBucketObjectsArgs.builder()
.bucketName("sample_bucket")
.keyRegex("sample/sample_object.txt")
.build());
ctx.export("firstObjectKey", bucketObjectsDs.objects()[0].key());
}
}
Content copied to clipboard
variables:
bucketObjectsDs:
fn::invoke:
function: alicloud:oss:getBucketObjects
arguments:
bucketName: sample_bucket
keyRegex: sample/sample_object.txt
outputs:
firstObjectKey: ${bucketObjectsDs.objects[0].key}
Content copied to clipboard
Return
A collection of values returned by getBucketObjects.
Parameters
argument
A collection of arguments for invoking getBucketObjects.
suspend fun getBucketObjects(bucketName: String, keyPrefix: String? = null, keyRegex: String? = null, outputFile: String? = null): GetBucketObjectsResult
Return
A collection of values returned by getBucketObjects.
Parameters
bucket Name
Name of the bucket that contains the objects to find.
key Prefix
Filter results by the given key prefix (such as "path/to/folder/logs-").
key Regex
A regex string to filter results by key.
output File
File name where to save data source results (after running pulumi preview
).
See also
suspend fun getBucketObjects(argument: suspend GetBucketObjectsPlainArgsBuilder.() -> Unit): GetBucketObjectsResult
Return
A collection of values returned by getBucketObjects.
Parameters
argument
Builder for com.pulumi.alicloud.oss.kotlin.inputs.GetBucketObjectsPlainArgs.