1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. storage
  5. getBucketObjectContent
Google Cloud Classic v8.3.1 published on Wednesday, Sep 25, 2024 by Pulumi

gcp.storage.getBucketObjectContent

Explore with Pulumi AI

gcp logo
Google Cloud Classic v8.3.1 published on Wednesday, Sep 25, 2024 by Pulumi

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

    Warning: The object content will be saved in the state, and visiable to everyone who has access to the state file.

    Example Usage

    Example file object stored within a folder.

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const key = gcp.storage.getBucketObjectContent({
        name: "encryptedkey",
        bucket: "keystore",
    });
    export const encrypted = key.then(key => key.content);
    
    import pulumi
    import pulumi_gcp as gcp
    
    key = gcp.storage.get_bucket_object_content(name="encryptedkey",
        bucket="keystore")
    pulumi.export("encrypted", key.content)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/storage"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		key, err := storage.GetBucketObjectContent(ctx, &storage.GetBucketObjectContentArgs{
    			Name:   "encryptedkey",
    			Bucket: "keystore",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("encrypted", key.Content)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    
    return await Deployment.RunAsync(() => 
    {
        var key = Gcp.Storage.GetBucketObjectContent.Invoke(new()
        {
            Name = "encryptedkey",
            Bucket = "keystore",
        });
    
        return new Dictionary<string, object?>
        {
            ["encrypted"] = key.Apply(getBucketObjectContentResult => getBucketObjectContentResult.Content),
        };
    });
    
    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.GetBucketObjectContentArgs;
    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 key = StorageFunctions.getBucketObjectContent(GetBucketObjectContentArgs.builder()
                .name("encryptedkey")
                .bucket("keystore")
                .build());
    
            ctx.export("encrypted", key.applyValue(getBucketObjectContentResult -> getBucketObjectContentResult.content()));
        }
    }
    
    variables:
      key:
        fn::invoke:
          Function: gcp:storage:getBucketObjectContent
          Arguments:
            name: encryptedkey
            bucket: keystore
    outputs:
      encrypted: ${key.content}
    

    Using getBucketObjectContent

    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 getBucketObjectContent(args: GetBucketObjectContentArgs, opts?: InvokeOptions): Promise<GetBucketObjectContentResult>
    function getBucketObjectContentOutput(args: GetBucketObjectContentOutputArgs, opts?: InvokeOptions): Output<GetBucketObjectContentResult>
    def get_bucket_object_content(bucket: Optional[str] = None,
                                  content: Optional[str] = None,
                                  name: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetBucketObjectContentResult
    def get_bucket_object_content_output(bucket: Optional[pulumi.Input[str]] = None,
                                  content: Optional[pulumi.Input[str]] = None,
                                  name: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetBucketObjectContentResult]
    func GetBucketObjectContent(ctx *Context, args *GetBucketObjectContentArgs, opts ...InvokeOption) (*GetBucketObjectContentResult, error)
    func GetBucketObjectContentOutput(ctx *Context, args *GetBucketObjectContentOutputArgs, opts ...InvokeOption) GetBucketObjectContentResultOutput

    > Note: This function is named GetBucketObjectContent in the Go SDK.

    public static class GetBucketObjectContent 
    {
        public static Task<GetBucketObjectContentResult> InvokeAsync(GetBucketObjectContentArgs args, InvokeOptions? opts = null)
        public static Output<GetBucketObjectContentResult> Invoke(GetBucketObjectContentInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetBucketObjectContentResult> getBucketObjectContent(GetBucketObjectContentArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: gcp:storage/getBucketObjectContent:getBucketObjectContent
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Bucket string
    The name of the containing bucket.
    Name string
    The name of the object.
    Content string
    (Computed) Content-Language of the object content.
    Bucket string
    The name of the containing bucket.
    Name string
    The name of the object.
    Content string
    (Computed) Content-Language of the object content.
    bucket String
    The name of the containing bucket.
    name String
    The name of the object.
    content String
    (Computed) Content-Language of the object content.
    bucket string
    The name of the containing bucket.
    name string
    The name of the object.
    content string
    (Computed) Content-Language of the object content.
    bucket str
    The name of the containing bucket.
    name str
    The name of the object.
    content str
    (Computed) Content-Language of the object content.
    bucket String
    The name of the containing bucket.
    name String
    The name of the object.
    content String
    (Computed) Content-Language of the object content.

    getBucketObjectContent Result

    The following output properties are available:

    Bucket string
    CacheControl string
    ContentDisposition string
    ContentEncoding string
    ContentLanguage string
    ContentType string
    Crc32c string
    CustomerEncryptions List<GetBucketObjectContentCustomerEncryption>
    DetectMd5hash string
    EventBasedHold bool
    Generation int
    Id string
    The provider-assigned unique ID for this managed resource.
    KmsKeyName string
    Md5hash string
    MediaLink string
    Metadata Dictionary<string, string>
    Name string
    OutputName string
    Retentions List<GetBucketObjectContentRetention>
    SelfLink string
    Source string
    StorageClass string
    TemporaryHold bool
    Content string
    (Computed) Content-Language of the object content.
    Bucket string
    CacheControl string
    ContentDisposition string
    ContentEncoding string
    ContentLanguage string
    ContentType string
    Crc32c string
    CustomerEncryptions []GetBucketObjectContentCustomerEncryption
    DetectMd5hash string
    EventBasedHold bool
    Generation int
    Id string
    The provider-assigned unique ID for this managed resource.
    KmsKeyName string
    Md5hash string
    MediaLink string
    Metadata map[string]string
    Name string
    OutputName string
    Retentions []GetBucketObjectContentRetention
    SelfLink string
    Source string
    StorageClass string
    TemporaryHold bool
    Content string
    (Computed) Content-Language of the object content.
    bucket String
    cacheControl String
    contentDisposition String
    contentEncoding String
    contentLanguage String
    contentType String
    crc32c String
    customerEncryptions List<GetBucketObjectContentCustomerEncryption>
    detectMd5hash String
    eventBasedHold Boolean
    generation Integer
    id String
    The provider-assigned unique ID for this managed resource.
    kmsKeyName String
    md5hash String
    mediaLink String
    metadata Map<String,String>
    name String
    outputName String
    retentions List<GetBucketObjectContentRetention>
    selfLink String
    source String
    storageClass String
    temporaryHold Boolean
    content String
    (Computed) Content-Language of the object content.
    bucket string
    cacheControl string
    contentDisposition string
    contentEncoding string
    contentLanguage string
    contentType string
    crc32c string
    customerEncryptions GetBucketObjectContentCustomerEncryption[]
    detectMd5hash string
    eventBasedHold boolean
    generation number
    id string
    The provider-assigned unique ID for this managed resource.
    kmsKeyName string
    md5hash string
    mediaLink string
    metadata {[key: string]: string}
    name string
    outputName string
    retentions GetBucketObjectContentRetention[]
    selfLink string
    source string
    storageClass string
    temporaryHold boolean
    content string
    (Computed) Content-Language of the object content.
    bucket String
    cacheControl String
    contentDisposition String
    contentEncoding String
    contentLanguage String
    contentType String
    crc32c String
    customerEncryptions List<Property Map>
    detectMd5hash String
    eventBasedHold Boolean
    generation Number
    id String
    The provider-assigned unique ID for this managed resource.
    kmsKeyName String
    md5hash String
    mediaLink String
    metadata Map<String>
    name String
    outputName String
    retentions List<Property Map>
    selfLink String
    source String
    storageClass String
    temporaryHold Boolean
    content String
    (Computed) Content-Language of the object content.

    Supporting Types

    GetBucketObjectContentCustomerEncryption

    EncryptionAlgorithm string
    The encryption algorithm. Default: AES256
    EncryptionKey string
    Base64 encoded customer supplied encryption key.
    EncryptionAlgorithm string
    The encryption algorithm. Default: AES256
    EncryptionKey string
    Base64 encoded customer supplied encryption key.
    encryptionAlgorithm String
    The encryption algorithm. Default: AES256
    encryptionKey String
    Base64 encoded customer supplied encryption key.
    encryptionAlgorithm string
    The encryption algorithm. Default: AES256
    encryptionKey string
    Base64 encoded customer supplied encryption key.
    encryption_algorithm str
    The encryption algorithm. Default: AES256
    encryption_key str
    Base64 encoded customer supplied encryption key.
    encryptionAlgorithm String
    The encryption algorithm. Default: AES256
    encryptionKey String
    Base64 encoded customer supplied encryption key.

    GetBucketObjectContentRetention

    Mode string
    The object retention mode. Supported values include: "Unlocked", "Locked".
    RetainUntilTime string
    Time in RFC 3339 (e.g. 2030-01-01T02:03:04Z) until which object retention protects this object.
    Mode string
    The object retention mode. Supported values include: "Unlocked", "Locked".
    RetainUntilTime string
    Time in RFC 3339 (e.g. 2030-01-01T02:03:04Z) until which object retention protects this object.
    mode String
    The object retention mode. Supported values include: "Unlocked", "Locked".
    retainUntilTime String
    Time in RFC 3339 (e.g. 2030-01-01T02:03:04Z) until which object retention protects this object.
    mode string
    The object retention mode. Supported values include: "Unlocked", "Locked".
    retainUntilTime string
    Time in RFC 3339 (e.g. 2030-01-01T02:03:04Z) until which object retention protects this object.
    mode str
    The object retention mode. Supported values include: "Unlocked", "Locked".
    retain_until_time str
    Time in RFC 3339 (e.g. 2030-01-01T02:03:04Z) until which object retention protects this object.
    mode String
    The object retention mode. Supported values include: "Unlocked", "Locked".
    retainUntilTime String
    Time in RFC 3339 (e.g. 2030-01-01T02:03:04Z) until which object retention protects this object.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud Classic v8.3.1 published on Wednesday, Sep 25, 2024 by Pulumi