getBucketObject function

Future<GetBucketObjectResult> getBucketObject(GetBucketObjectArgs args, { InvokeOptions? options, })

Gets an existing object inside an existing bucket in Google Cloud Storage service (GCS). See the official documentation and API.

Example Usage

Example picture stored within a folder.

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

const picture = gcp.storage.getBucketObject({
    name: "folder/butterfly01.jpg",
    bucket: "image-store",
});

import pulumi
import pulumi_gcp as gcp

picture = gcp.storage.get_bucket_object(name="folder/butterfly01.jpg",
    bucket="image-store")

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

return await Deployment.RunAsync(() =>
{
    var picture = Gcp.Storage.GetBucketObject.Invoke(new()
    {
        Name = "folder/butterfly01.jpg",
        Bucket = "image-store",
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/storage"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := storage.LookupBucketObject(ctx, &storage.LookupBucketObjectArgs{
			Name:   pulumi.StringRef("folder/butterfly01.jpg"),
			Bucket: pulumi.StringRef("image-store"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

data "gcp_storage_getbucketobject" "picture" {
  name   = "folder/butterfly01.jpg"
  bucket = "image-store"
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.storage.StorageFunctions;
import com.pulumi.gcp.storage.inputs.GetBucketObjectArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 picture = StorageFunctions.getBucketObject(GetBucketObjectArgs.builder()
            .name("folder/butterfly01.jpg")
            .bucket("image-store")
            .build());

    }
}

variables:
  picture:
    fn::invoke:
      function: gcp:storage:getBucketObject
      arguments:
        name: folder/butterfly01.jpg
        bucket: image-store

args Arguments passed to this invoke. Arguments for getBucketObject. options Invoke options controlling this call.

Implementation

Future<GetBucketObjectResult> getBucketObject(
  GetBucketObjectArgs args, {
  pulumi.InvokeOptions? options,
}) async {
  final deployment = pulumi.Deployment.instance;
  final result = await deployment.invoke<Map<String, dynamic>>(
    'gcp:storage/getBucketObject:getBucketObject',
    args.toMap(),
    options: pulumi.toDeploymentInvokeOptions(options),
  );
  return GetBucketObjectResult.fromMap(result);
}