1. Packages
  2. Linode
  3. API Docs
  4. ObjectStorageObject
Linode v4.22.1 published on Wednesday, Jul 3, 2024 by Pulumi

linode.ObjectStorageObject

Explore with Pulumi AI

linode logo
Linode v4.22.1 published on Wednesday, Jul 3, 2024 by Pulumi

    Provides a Linode Object Storage Object resource. This can be used to create, modify, and delete Linodes Object Storage Objects for Buckets.

    Example Usage

    Uploading a file to a bucket

    import * as pulumi from "@pulumi/pulumi";
    import * as linode from "@pulumi/linode";
    import * as std from "@pulumi/std";
    
    const object = new linode.ObjectStorageObject("object", {
        bucket: "my-bucket",
        cluster: "us-east-1",
        key: "my-object",
        secretKey: myKey.secretKey,
        accessKey: myKey.accessKey,
        source: std.pathexpand({
            input: "~/files/log.txt",
        }).then(invoke => invoke.result),
    });
    
    import pulumi
    import pulumi_linode as linode
    import pulumi_std as std
    
    object = linode.ObjectStorageObject("object",
        bucket="my-bucket",
        cluster="us-east-1",
        key="my-object",
        secret_key=my_key["secretKey"],
        access_key=my_key["accessKey"],
        source=std.pathexpand(input="~/files/log.txt").result)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-linode/sdk/v4/go/linode"
    	"github.com/pulumi/pulumi-std/sdk/go/std"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		invokePathexpand, err := std.Pathexpand(ctx, &std.PathexpandArgs{
    			Input: "~/files/log.txt",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = linode.NewObjectStorageObject(ctx, "object", &linode.ObjectStorageObjectArgs{
    			Bucket:    pulumi.String("my-bucket"),
    			Cluster:   pulumi.String("us-east-1"),
    			Key:       pulumi.String("my-object"),
    			SecretKey: pulumi.Any(myKey.SecretKey),
    			AccessKey: pulumi.Any(myKey.AccessKey),
    			Source:    invokePathexpand.Result,
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Linode = Pulumi.Linode;
    using Std = Pulumi.Std;
    
    return await Deployment.RunAsync(() => 
    {
        var @object = new Linode.ObjectStorageObject("object", new()
        {
            Bucket = "my-bucket",
            Cluster = "us-east-1",
            Key = "my-object",
            SecretKey = myKey.SecretKey,
            AccessKey = myKey.AccessKey,
            Source = Std.Pathexpand.Invoke(new()
            {
                Input = "~/files/log.txt",
            }).Apply(invoke => invoke.Result),
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.linode.ObjectStorageObject;
    import com.pulumi.linode.ObjectStorageObjectArgs;
    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) {
            var object = new ObjectStorageObject("object", ObjectStorageObjectArgs.builder()
                .bucket("my-bucket")
                .cluster("us-east-1")
                .key("my-object")
                .secretKey(myKey.secretKey())
                .accessKey(myKey.accessKey())
                .source(StdFunctions.pathexpand(PathexpandArgs.builder()
                    .input("~/files/log.txt")
                    .build()).result())
                .build());
    
        }
    }
    
    resources:
      object:
        type: linode:ObjectStorageObject
        properties:
          bucket: my-bucket
          cluster: us-east-1
          key: my-object
          secretKey: ${myKey.secretKey}
          accessKey: ${myKey.accessKey}
          source:
            fn::invoke:
              Function: std:pathexpand
              Arguments:
                input: ~/files/log.txt
              Return: result
    

    Uploading plaintext to a bucket

    import * as pulumi from "@pulumi/pulumi";
    import * as linode from "@pulumi/linode";
    
    const object = new linode.ObjectStorageObject("object", {
        bucket: "my-bucket",
        cluster: "us-east-1",
        key: "my-object",
        secretKey: myKey.secretKey,
        accessKey: myKey.accessKey,
        content: "This is the content of the Object...",
        contentType: "text/plain",
        contentLanguage: "en",
    });
    
    import pulumi
    import pulumi_linode as linode
    
    object = linode.ObjectStorageObject("object",
        bucket="my-bucket",
        cluster="us-east-1",
        key="my-object",
        secret_key=my_key["secretKey"],
        access_key=my_key["accessKey"],
        content="This is the content of the Object...",
        content_type="text/plain",
        content_language="en")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-linode/sdk/v4/go/linode"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := linode.NewObjectStorageObject(ctx, "object", &linode.ObjectStorageObjectArgs{
    			Bucket:          pulumi.String("my-bucket"),
    			Cluster:         pulumi.String("us-east-1"),
    			Key:             pulumi.String("my-object"),
    			SecretKey:       pulumi.Any(myKey.SecretKey),
    			AccessKey:       pulumi.Any(myKey.AccessKey),
    			Content:         pulumi.String("This is the content of the Object..."),
    			ContentType:     pulumi.String("text/plain"),
    			ContentLanguage: pulumi.String("en"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Linode = Pulumi.Linode;
    
    return await Deployment.RunAsync(() => 
    {
        var @object = new Linode.ObjectStorageObject("object", new()
        {
            Bucket = "my-bucket",
            Cluster = "us-east-1",
            Key = "my-object",
            SecretKey = myKey.SecretKey,
            AccessKey = myKey.AccessKey,
            Content = "This is the content of the Object...",
            ContentType = "text/plain",
            ContentLanguage = "en",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.linode.ObjectStorageObject;
    import com.pulumi.linode.ObjectStorageObjectArgs;
    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) {
            var object = new ObjectStorageObject("object", ObjectStorageObjectArgs.builder()
                .bucket("my-bucket")
                .cluster("us-east-1")
                .key("my-object")
                .secretKey(myKey.secretKey())
                .accessKey(myKey.accessKey())
                .content("This is the content of the Object...")
                .contentType("text/plain")
                .contentLanguage("en")
                .build());
    
        }
    }
    
    resources:
      object:
        type: linode:ObjectStorageObject
        properties:
          bucket: my-bucket
          cluster: us-east-1
          key: my-object
          secretKey: ${myKey.secretKey}
          accessKey: ${myKey.accessKey}
          content: This is the content of the Object...
          contentType: text/plain
          contentLanguage: en
    

    Creating an object using implicitly created object credentials

    import * as pulumi from "@pulumi/pulumi";
    import * as linode from "@pulumi/linode";
    import * as std from "@pulumi/std";
    
    const object = new linode.ObjectStorageObject("object", {
        bucket: "my-bucket",
        cluster: "us-east-1",
        key: "my-object",
        source: std.pathexpand({
            input: "~/files/log.txt",
        }).then(invoke => invoke.result),
    });
    
    import pulumi
    import pulumi_linode as linode
    import pulumi_std as std
    
    object = linode.ObjectStorageObject("object",
        bucket="my-bucket",
        cluster="us-east-1",
        key="my-object",
        source=std.pathexpand(input="~/files/log.txt").result)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-linode/sdk/v4/go/linode"
    	"github.com/pulumi/pulumi-std/sdk/go/std"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		invokePathexpand, err := std.Pathexpand(ctx, &std.PathexpandArgs{
    			Input: "~/files/log.txt",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = linode.NewObjectStorageObject(ctx, "object", &linode.ObjectStorageObjectArgs{
    			Bucket:  pulumi.String("my-bucket"),
    			Cluster: pulumi.String("us-east-1"),
    			Key:     pulumi.String("my-object"),
    			Source:  invokePathexpand.Result,
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Linode = Pulumi.Linode;
    using Std = Pulumi.Std;
    
    return await Deployment.RunAsync(() => 
    {
        var @object = new Linode.ObjectStorageObject("object", new()
        {
            Bucket = "my-bucket",
            Cluster = "us-east-1",
            Key = "my-object",
            Source = Std.Pathexpand.Invoke(new()
            {
                Input = "~/files/log.txt",
            }).Apply(invoke => invoke.Result),
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.linode.ObjectStorageObject;
    import com.pulumi.linode.ObjectStorageObjectArgs;
    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) {
            var object = new ObjectStorageObject("object", ObjectStorageObjectArgs.builder()
                .bucket("my-bucket")
                .cluster("us-east-1")
                .key("my-object")
                .source(StdFunctions.pathexpand(PathexpandArgs.builder()
                    .input("~/files/log.txt")
                    .build()).result())
                .build());
    
        }
    }
    
    resources:
      object:
        type: linode:ObjectStorageObject
        properties:
          bucket: my-bucket
          cluster: us-east-1
          key: my-object
          source:
            fn::invoke:
              Function: std:pathexpand
              Arguments:
                input: ~/files/log.txt
              Return: result
    

    Create ObjectStorageObject Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ObjectStorageObject(name: string, args: ObjectStorageObjectArgs, opts?: CustomResourceOptions);
    @overload
    def ObjectStorageObject(resource_name: str,
                            args: ObjectStorageObjectArgs,
                            opts: Optional[ResourceOptions] = None)
    
    @overload
    def ObjectStorageObject(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            cluster: Optional[str] = None,
                            key: Optional[str] = None,
                            bucket: Optional[str] = None,
                            content_encoding: Optional[str] = None,
                            content_type: Optional[str] = None,
                            content: Optional[str] = None,
                            content_base64: Optional[str] = None,
                            content_disposition: Optional[str] = None,
                            access_key: Optional[str] = None,
                            content_language: Optional[str] = None,
                            cache_control: Optional[str] = None,
                            endpoint: Optional[str] = None,
                            etag: Optional[str] = None,
                            force_destroy: Optional[bool] = None,
                            acl: Optional[str] = None,
                            metadata: Optional[Mapping[str, str]] = None,
                            secret_key: Optional[str] = None,
                            source: Optional[str] = None,
                            website_redirect: Optional[str] = None)
    func NewObjectStorageObject(ctx *Context, name string, args ObjectStorageObjectArgs, opts ...ResourceOption) (*ObjectStorageObject, error)
    public ObjectStorageObject(string name, ObjectStorageObjectArgs args, CustomResourceOptions? opts = null)
    public ObjectStorageObject(String name, ObjectStorageObjectArgs args)
    public ObjectStorageObject(String name, ObjectStorageObjectArgs args, CustomResourceOptions options)
    
    type: linode:ObjectStorageObject
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ObjectStorageObjectArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ObjectStorageObjectArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ObjectStorageObjectArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ObjectStorageObjectArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ObjectStorageObjectArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var objectStorageObjectResource = new Linode.ObjectStorageObject("objectStorageObjectResource", new()
    {
        Cluster = "string",
        Key = "string",
        Bucket = "string",
        ContentEncoding = "string",
        ContentType = "string",
        Content = "string",
        ContentBase64 = "string",
        ContentDisposition = "string",
        AccessKey = "string",
        ContentLanguage = "string",
        CacheControl = "string",
        Endpoint = "string",
        Etag = "string",
        ForceDestroy = false,
        Acl = "string",
        Metadata = 
        {
            { "string", "string" },
        },
        SecretKey = "string",
        Source = "string",
        WebsiteRedirect = "string",
    });
    
    example, err := linode.NewObjectStorageObject(ctx, "objectStorageObjectResource", &linode.ObjectStorageObjectArgs{
    	Cluster:            pulumi.String("string"),
    	Key:                pulumi.String("string"),
    	Bucket:             pulumi.String("string"),
    	ContentEncoding:    pulumi.String("string"),
    	ContentType:        pulumi.String("string"),
    	Content:            pulumi.String("string"),
    	ContentBase64:      pulumi.String("string"),
    	ContentDisposition: pulumi.String("string"),
    	AccessKey:          pulumi.String("string"),
    	ContentLanguage:    pulumi.String("string"),
    	CacheControl:       pulumi.String("string"),
    	Endpoint:           pulumi.String("string"),
    	Etag:               pulumi.String("string"),
    	ForceDestroy:       pulumi.Bool(false),
    	Acl:                pulumi.String("string"),
    	Metadata: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	SecretKey:       pulumi.String("string"),
    	Source:          pulumi.String("string"),
    	WebsiteRedirect: pulumi.String("string"),
    })
    
    var objectStorageObjectResource = new ObjectStorageObject("objectStorageObjectResource", ObjectStorageObjectArgs.builder()
        .cluster("string")
        .key("string")
        .bucket("string")
        .contentEncoding("string")
        .contentType("string")
        .content("string")
        .contentBase64("string")
        .contentDisposition("string")
        .accessKey("string")
        .contentLanguage("string")
        .cacheControl("string")
        .endpoint("string")
        .etag("string")
        .forceDestroy(false)
        .acl("string")
        .metadata(Map.of("string", "string"))
        .secretKey("string")
        .source("string")
        .websiteRedirect("string")
        .build());
    
    object_storage_object_resource = linode.ObjectStorageObject("objectStorageObjectResource",
        cluster="string",
        key="string",
        bucket="string",
        content_encoding="string",
        content_type="string",
        content="string",
        content_base64="string",
        content_disposition="string",
        access_key="string",
        content_language="string",
        cache_control="string",
        endpoint="string",
        etag="string",
        force_destroy=False,
        acl="string",
        metadata={
            "string": "string",
        },
        secret_key="string",
        source="string",
        website_redirect="string")
    
    const objectStorageObjectResource = new linode.ObjectStorageObject("objectStorageObjectResource", {
        cluster: "string",
        key: "string",
        bucket: "string",
        contentEncoding: "string",
        contentType: "string",
        content: "string",
        contentBase64: "string",
        contentDisposition: "string",
        accessKey: "string",
        contentLanguage: "string",
        cacheControl: "string",
        endpoint: "string",
        etag: "string",
        forceDestroy: false,
        acl: "string",
        metadata: {
            string: "string",
        },
        secretKey: "string",
        source: "string",
        websiteRedirect: "string",
    });
    
    type: linode:ObjectStorageObject
    properties:
        accessKey: string
        acl: string
        bucket: string
        cacheControl: string
        cluster: string
        content: string
        contentBase64: string
        contentDisposition: string
        contentEncoding: string
        contentLanguage: string
        contentType: string
        endpoint: string
        etag: string
        forceDestroy: false
        key: string
        metadata:
            string: string
        secretKey: string
        source: string
        websiteRedirect: string
    

    ObjectStorageObject Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ObjectStorageObject resource accepts the following input properties:

    Bucket string
    The name of the bucket to put the object in.
    Cluster string
    The cluster the bucket is in.
    Key string
    They name of the object once it is in the bucket.
    AccessKey string
    The REQUIRED access key to authenticate with. If it's not specified with the resource, you must provide its value by

    • configuring the obj_access_key in the provider configuration;
    • or, opting-in generating it implicitly at apply-time using obj_use_temp_keys at provider-level.
    Acl string
    The canned ACL to apply. (private, public-read, authenticated-read, public-read-write, custom) (defaults to private).
    CacheControl string
    Specifies caching behavior along the request/reply chain Read w3c cache_control for further details.
    Content string
    Literal string value to use as the object content, which will be uploaded as UTF-8-encoded text.
    ContentBase64 string
    Base64-encoded data that will be decoded and uploaded as raw bytes for the object content. This allows safely uploading non-UTF8 binary data, but is recommended only for small content such as the result of the gzipbase64 function with small text strings. For larger objects, use source to stream the content from a disk file.
    ContentDisposition string
    Specifies presentational information for the object. Read w3c content_disposition for further information.
    ContentEncoding string
    Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. Read w3c content encoding for further information.
    ContentLanguage string
    The language the content is in e.g. en-US or en-GB.
    ContentType string
    A standard MIME type describing the format of the object data, e.g. application/octet-stream. All Valid MIME Types are valid for this input.
    Endpoint string
    Used with the s3 client to make bucket changes and will be computed automatically if left blank, override for testing/debug purposes.
    Etag string
    The specific version of this object.
    ForceDestroy bool
    Allow the object to be deleted regardless of any legal hold or object lock (defaults to false).
    Metadata Dictionary<string, string>
    A map of keys/values to provision metadata.
    SecretKey string
    The REQUIRED secret key to authenticate with. If it's not specified with the resource, you must provide its value by

    • configuring the obj_secret_key in the provider configuration;
    • or, opting-in generating it implicitly at apply-time using obj_use_temp_keys at provider-level.
    Source string
    The path to a file that will be read and uploaded as raw bytes for the object content. The path must either be relative to the root module or absolute.
    WebsiteRedirect string
    Specifies a target URL for website redirect.
    Bucket string
    The name of the bucket to put the object in.
    Cluster string
    The cluster the bucket is in.
    Key string
    They name of the object once it is in the bucket.
    AccessKey string
    The REQUIRED access key to authenticate with. If it's not specified with the resource, you must provide its value by

    • configuring the obj_access_key in the provider configuration;
    • or, opting-in generating it implicitly at apply-time using obj_use_temp_keys at provider-level.
    Acl string
    The canned ACL to apply. (private, public-read, authenticated-read, public-read-write, custom) (defaults to private).
    CacheControl string
    Specifies caching behavior along the request/reply chain Read w3c cache_control for further details.
    Content string
    Literal string value to use as the object content, which will be uploaded as UTF-8-encoded text.
    ContentBase64 string
    Base64-encoded data that will be decoded and uploaded as raw bytes for the object content. This allows safely uploading non-UTF8 binary data, but is recommended only for small content such as the result of the gzipbase64 function with small text strings. For larger objects, use source to stream the content from a disk file.
    ContentDisposition string
    Specifies presentational information for the object. Read w3c content_disposition for further information.
    ContentEncoding string
    Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. Read w3c content encoding for further information.
    ContentLanguage string
    The language the content is in e.g. en-US or en-GB.
    ContentType string
    A standard MIME type describing the format of the object data, e.g. application/octet-stream. All Valid MIME Types are valid for this input.
    Endpoint string
    Used with the s3 client to make bucket changes and will be computed automatically if left blank, override for testing/debug purposes.
    Etag string
    The specific version of this object.
    ForceDestroy bool
    Allow the object to be deleted regardless of any legal hold or object lock (defaults to false).
    Metadata map[string]string
    A map of keys/values to provision metadata.
    SecretKey string
    The REQUIRED secret key to authenticate with. If it's not specified with the resource, you must provide its value by

    • configuring the obj_secret_key in the provider configuration;
    • or, opting-in generating it implicitly at apply-time using obj_use_temp_keys at provider-level.
    Source string
    The path to a file that will be read and uploaded as raw bytes for the object content. The path must either be relative to the root module or absolute.
    WebsiteRedirect string
    Specifies a target URL for website redirect.
    bucket String
    The name of the bucket to put the object in.
    cluster String
    The cluster the bucket is in.
    key String
    They name of the object once it is in the bucket.
    accessKey String
    The REQUIRED access key to authenticate with. If it's not specified with the resource, you must provide its value by

    • configuring the obj_access_key in the provider configuration;
    • or, opting-in generating it implicitly at apply-time using obj_use_temp_keys at provider-level.
    acl String
    The canned ACL to apply. (private, public-read, authenticated-read, public-read-write, custom) (defaults to private).
    cacheControl String
    Specifies caching behavior along the request/reply chain Read w3c cache_control for further details.
    content String
    Literal string value to use as the object content, which will be uploaded as UTF-8-encoded text.
    contentBase64 String
    Base64-encoded data that will be decoded and uploaded as raw bytes for the object content. This allows safely uploading non-UTF8 binary data, but is recommended only for small content such as the result of the gzipbase64 function with small text strings. For larger objects, use source to stream the content from a disk file.
    contentDisposition String
    Specifies presentational information for the object. Read w3c content_disposition for further information.
    contentEncoding String
    Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. Read w3c content encoding for further information.
    contentLanguage String
    The language the content is in e.g. en-US or en-GB.
    contentType String
    A standard MIME type describing the format of the object data, e.g. application/octet-stream. All Valid MIME Types are valid for this input.
    endpoint String
    Used with the s3 client to make bucket changes and will be computed automatically if left blank, override for testing/debug purposes.
    etag String
    The specific version of this object.
    forceDestroy Boolean
    Allow the object to be deleted regardless of any legal hold or object lock (defaults to false).
    metadata Map<String,String>
    A map of keys/values to provision metadata.
    secretKey String
    The REQUIRED secret key to authenticate with. If it's not specified with the resource, you must provide its value by

    • configuring the obj_secret_key in the provider configuration;
    • or, opting-in generating it implicitly at apply-time using obj_use_temp_keys at provider-level.
    source String
    The path to a file that will be read and uploaded as raw bytes for the object content. The path must either be relative to the root module or absolute.
    websiteRedirect String
    Specifies a target URL for website redirect.
    bucket string
    The name of the bucket to put the object in.
    cluster string
    The cluster the bucket is in.
    key string
    They name of the object once it is in the bucket.
    accessKey string
    The REQUIRED access key to authenticate with. If it's not specified with the resource, you must provide its value by

    • configuring the obj_access_key in the provider configuration;
    • or, opting-in generating it implicitly at apply-time using obj_use_temp_keys at provider-level.
    acl string
    The canned ACL to apply. (private, public-read, authenticated-read, public-read-write, custom) (defaults to private).
    cacheControl string
    Specifies caching behavior along the request/reply chain Read w3c cache_control for further details.
    content string
    Literal string value to use as the object content, which will be uploaded as UTF-8-encoded text.
    contentBase64 string
    Base64-encoded data that will be decoded and uploaded as raw bytes for the object content. This allows safely uploading non-UTF8 binary data, but is recommended only for small content such as the result of the gzipbase64 function with small text strings. For larger objects, use source to stream the content from a disk file.
    contentDisposition string
    Specifies presentational information for the object. Read w3c content_disposition for further information.
    contentEncoding string
    Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. Read w3c content encoding for further information.
    contentLanguage string
    The language the content is in e.g. en-US or en-GB.
    contentType string
    A standard MIME type describing the format of the object data, e.g. application/octet-stream. All Valid MIME Types are valid for this input.
    endpoint string
    Used with the s3 client to make bucket changes and will be computed automatically if left blank, override for testing/debug purposes.
    etag string
    The specific version of this object.
    forceDestroy boolean
    Allow the object to be deleted regardless of any legal hold or object lock (defaults to false).
    metadata {[key: string]: string}
    A map of keys/values to provision metadata.
    secretKey string
    The REQUIRED secret key to authenticate with. If it's not specified with the resource, you must provide its value by

    • configuring the obj_secret_key in the provider configuration;
    • or, opting-in generating it implicitly at apply-time using obj_use_temp_keys at provider-level.
    source string
    The path to a file that will be read and uploaded as raw bytes for the object content. The path must either be relative to the root module or absolute.
    websiteRedirect string
    Specifies a target URL for website redirect.
    bucket str
    The name of the bucket to put the object in.
    cluster str
    The cluster the bucket is in.
    key str
    They name of the object once it is in the bucket.
    access_key str
    The REQUIRED access key to authenticate with. If it's not specified with the resource, you must provide its value by

    • configuring the obj_access_key in the provider configuration;
    • or, opting-in generating it implicitly at apply-time using obj_use_temp_keys at provider-level.
    acl str
    The canned ACL to apply. (private, public-read, authenticated-read, public-read-write, custom) (defaults to private).
    cache_control str
    Specifies caching behavior along the request/reply chain Read w3c cache_control for further details.
    content str
    Literal string value to use as the object content, which will be uploaded as UTF-8-encoded text.
    content_base64 str
    Base64-encoded data that will be decoded and uploaded as raw bytes for the object content. This allows safely uploading non-UTF8 binary data, but is recommended only for small content such as the result of the gzipbase64 function with small text strings. For larger objects, use source to stream the content from a disk file.
    content_disposition str
    Specifies presentational information for the object. Read w3c content_disposition for further information.
    content_encoding str
    Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. Read w3c content encoding for further information.
    content_language str
    The language the content is in e.g. en-US or en-GB.
    content_type str
    A standard MIME type describing the format of the object data, e.g. application/octet-stream. All Valid MIME Types are valid for this input.
    endpoint str
    Used with the s3 client to make bucket changes and will be computed automatically if left blank, override for testing/debug purposes.
    etag str
    The specific version of this object.
    force_destroy bool
    Allow the object to be deleted regardless of any legal hold or object lock (defaults to false).
    metadata Mapping[str, str]
    A map of keys/values to provision metadata.
    secret_key str
    The REQUIRED secret key to authenticate with. If it's not specified with the resource, you must provide its value by

    • configuring the obj_secret_key in the provider configuration;
    • or, opting-in generating it implicitly at apply-time using obj_use_temp_keys at provider-level.
    source str
    The path to a file that will be read and uploaded as raw bytes for the object content. The path must either be relative to the root module or absolute.
    website_redirect str
    Specifies a target URL for website redirect.
    bucket String
    The name of the bucket to put the object in.
    cluster String
    The cluster the bucket is in.
    key String
    They name of the object once it is in the bucket.
    accessKey String
    The REQUIRED access key to authenticate with. If it's not specified with the resource, you must provide its value by

    • configuring the obj_access_key in the provider configuration;
    • or, opting-in generating it implicitly at apply-time using obj_use_temp_keys at provider-level.
    acl String
    The canned ACL to apply. (private, public-read, authenticated-read, public-read-write, custom) (defaults to private).
    cacheControl String
    Specifies caching behavior along the request/reply chain Read w3c cache_control for further details.
    content String
    Literal string value to use as the object content, which will be uploaded as UTF-8-encoded text.
    contentBase64 String
    Base64-encoded data that will be decoded and uploaded as raw bytes for the object content. This allows safely uploading non-UTF8 binary data, but is recommended only for small content such as the result of the gzipbase64 function with small text strings. For larger objects, use source to stream the content from a disk file.
    contentDisposition String
    Specifies presentational information for the object. Read w3c content_disposition for further information.
    contentEncoding String
    Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. Read w3c content encoding for further information.
    contentLanguage String
    The language the content is in e.g. en-US or en-GB.
    contentType String
    A standard MIME type describing the format of the object data, e.g. application/octet-stream. All Valid MIME Types are valid for this input.
    endpoint String
    Used with the s3 client to make bucket changes and will be computed automatically if left blank, override for testing/debug purposes.
    etag String
    The specific version of this object.
    forceDestroy Boolean
    Allow the object to be deleted regardless of any legal hold or object lock (defaults to false).
    metadata Map<String>
    A map of keys/values to provision metadata.
    secretKey String
    The REQUIRED secret key to authenticate with. If it's not specified with the resource, you must provide its value by

    • configuring the obj_secret_key in the provider configuration;
    • or, opting-in generating it implicitly at apply-time using obj_use_temp_keys at provider-level.
    source String
    The path to a file that will be read and uploaded as raw bytes for the object content. The path must either be relative to the root module or absolute.
    websiteRedirect String
    Specifies a target URL for website redirect.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ObjectStorageObject resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    VersionId string
    A unique version ID value for the object.
    Id string
    The provider-assigned unique ID for this managed resource.
    VersionId string
    A unique version ID value for the object.
    id String
    The provider-assigned unique ID for this managed resource.
    versionId String
    A unique version ID value for the object.
    id string
    The provider-assigned unique ID for this managed resource.
    versionId string
    A unique version ID value for the object.
    id str
    The provider-assigned unique ID for this managed resource.
    version_id str
    A unique version ID value for the object.
    id String
    The provider-assigned unique ID for this managed resource.
    versionId String
    A unique version ID value for the object.

    Look up Existing ObjectStorageObject Resource

    Get an existing ObjectStorageObject resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ObjectStorageObjectState, opts?: CustomResourceOptions): ObjectStorageObject
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            access_key: Optional[str] = None,
            acl: Optional[str] = None,
            bucket: Optional[str] = None,
            cache_control: Optional[str] = None,
            cluster: Optional[str] = None,
            content: Optional[str] = None,
            content_base64: Optional[str] = None,
            content_disposition: Optional[str] = None,
            content_encoding: Optional[str] = None,
            content_language: Optional[str] = None,
            content_type: Optional[str] = None,
            endpoint: Optional[str] = None,
            etag: Optional[str] = None,
            force_destroy: Optional[bool] = None,
            key: Optional[str] = None,
            metadata: Optional[Mapping[str, str]] = None,
            secret_key: Optional[str] = None,
            source: Optional[str] = None,
            version_id: Optional[str] = None,
            website_redirect: Optional[str] = None) -> ObjectStorageObject
    func GetObjectStorageObject(ctx *Context, name string, id IDInput, state *ObjectStorageObjectState, opts ...ResourceOption) (*ObjectStorageObject, error)
    public static ObjectStorageObject Get(string name, Input<string> id, ObjectStorageObjectState? state, CustomResourceOptions? opts = null)
    public static ObjectStorageObject get(String name, Output<String> id, ObjectStorageObjectState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AccessKey string
    The REQUIRED access key to authenticate with. If it's not specified with the resource, you must provide its value by

    • configuring the obj_access_key in the provider configuration;
    • or, opting-in generating it implicitly at apply-time using obj_use_temp_keys at provider-level.
    Acl string
    The canned ACL to apply. (private, public-read, authenticated-read, public-read-write, custom) (defaults to private).
    Bucket string
    The name of the bucket to put the object in.
    CacheControl string
    Specifies caching behavior along the request/reply chain Read w3c cache_control for further details.
    Cluster string
    The cluster the bucket is in.
    Content string
    Literal string value to use as the object content, which will be uploaded as UTF-8-encoded text.
    ContentBase64 string
    Base64-encoded data that will be decoded and uploaded as raw bytes for the object content. This allows safely uploading non-UTF8 binary data, but is recommended only for small content such as the result of the gzipbase64 function with small text strings. For larger objects, use source to stream the content from a disk file.
    ContentDisposition string
    Specifies presentational information for the object. Read w3c content_disposition for further information.
    ContentEncoding string
    Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. Read w3c content encoding for further information.
    ContentLanguage string
    The language the content is in e.g. en-US or en-GB.
    ContentType string
    A standard MIME type describing the format of the object data, e.g. application/octet-stream. All Valid MIME Types are valid for this input.
    Endpoint string
    Used with the s3 client to make bucket changes and will be computed automatically if left blank, override for testing/debug purposes.
    Etag string
    The specific version of this object.
    ForceDestroy bool
    Allow the object to be deleted regardless of any legal hold or object lock (defaults to false).
    Key string
    They name of the object once it is in the bucket.
    Metadata Dictionary<string, string>
    A map of keys/values to provision metadata.
    SecretKey string
    The REQUIRED secret key to authenticate with. If it's not specified with the resource, you must provide its value by

    • configuring the obj_secret_key in the provider configuration;
    • or, opting-in generating it implicitly at apply-time using obj_use_temp_keys at provider-level.
    Source string
    The path to a file that will be read and uploaded as raw bytes for the object content. The path must either be relative to the root module or absolute.
    VersionId string
    A unique version ID value for the object.
    WebsiteRedirect string
    Specifies a target URL for website redirect.
    AccessKey string
    The REQUIRED access key to authenticate with. If it's not specified with the resource, you must provide its value by

    • configuring the obj_access_key in the provider configuration;
    • or, opting-in generating it implicitly at apply-time using obj_use_temp_keys at provider-level.
    Acl string
    The canned ACL to apply. (private, public-read, authenticated-read, public-read-write, custom) (defaults to private).
    Bucket string
    The name of the bucket to put the object in.
    CacheControl string
    Specifies caching behavior along the request/reply chain Read w3c cache_control for further details.
    Cluster string
    The cluster the bucket is in.
    Content string
    Literal string value to use as the object content, which will be uploaded as UTF-8-encoded text.
    ContentBase64 string
    Base64-encoded data that will be decoded and uploaded as raw bytes for the object content. This allows safely uploading non-UTF8 binary data, but is recommended only for small content such as the result of the gzipbase64 function with small text strings. For larger objects, use source to stream the content from a disk file.
    ContentDisposition string
    Specifies presentational information for the object. Read w3c content_disposition for further information.
    ContentEncoding string
    Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. Read w3c content encoding for further information.
    ContentLanguage string
    The language the content is in e.g. en-US or en-GB.
    ContentType string
    A standard MIME type describing the format of the object data, e.g. application/octet-stream. All Valid MIME Types are valid for this input.
    Endpoint string
    Used with the s3 client to make bucket changes and will be computed automatically if left blank, override for testing/debug purposes.
    Etag string
    The specific version of this object.
    ForceDestroy bool
    Allow the object to be deleted regardless of any legal hold or object lock (defaults to false).
    Key string
    They name of the object once it is in the bucket.
    Metadata map[string]string
    A map of keys/values to provision metadata.
    SecretKey string
    The REQUIRED secret key to authenticate with. If it's not specified with the resource, you must provide its value by

    • configuring the obj_secret_key in the provider configuration;
    • or, opting-in generating it implicitly at apply-time using obj_use_temp_keys at provider-level.
    Source string
    The path to a file that will be read and uploaded as raw bytes for the object content. The path must either be relative to the root module or absolute.
    VersionId string
    A unique version ID value for the object.
    WebsiteRedirect string
    Specifies a target URL for website redirect.
    accessKey String
    The REQUIRED access key to authenticate with. If it's not specified with the resource, you must provide its value by

    • configuring the obj_access_key in the provider configuration;
    • or, opting-in generating it implicitly at apply-time using obj_use_temp_keys at provider-level.
    acl String
    The canned ACL to apply. (private, public-read, authenticated-read, public-read-write, custom) (defaults to private).
    bucket String
    The name of the bucket to put the object in.
    cacheControl String
    Specifies caching behavior along the request/reply chain Read w3c cache_control for further details.
    cluster String
    The cluster the bucket is in.
    content String
    Literal string value to use as the object content, which will be uploaded as UTF-8-encoded text.
    contentBase64 String
    Base64-encoded data that will be decoded and uploaded as raw bytes for the object content. This allows safely uploading non-UTF8 binary data, but is recommended only for small content such as the result of the gzipbase64 function with small text strings. For larger objects, use source to stream the content from a disk file.
    contentDisposition String
    Specifies presentational information for the object. Read w3c content_disposition for further information.
    contentEncoding String
    Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. Read w3c content encoding for further information.
    contentLanguage String
    The language the content is in e.g. en-US or en-GB.
    contentType String
    A standard MIME type describing the format of the object data, e.g. application/octet-stream. All Valid MIME Types are valid for this input.
    endpoint String
    Used with the s3 client to make bucket changes and will be computed automatically if left blank, override for testing/debug purposes.
    etag String
    The specific version of this object.
    forceDestroy Boolean
    Allow the object to be deleted regardless of any legal hold or object lock (defaults to false).
    key String
    They name of the object once it is in the bucket.
    metadata Map<String,String>
    A map of keys/values to provision metadata.
    secretKey String
    The REQUIRED secret key to authenticate with. If it's not specified with the resource, you must provide its value by

    • configuring the obj_secret_key in the provider configuration;
    • or, opting-in generating it implicitly at apply-time using obj_use_temp_keys at provider-level.
    source String
    The path to a file that will be read and uploaded as raw bytes for the object content. The path must either be relative to the root module or absolute.
    versionId String
    A unique version ID value for the object.
    websiteRedirect String
    Specifies a target URL for website redirect.
    accessKey string
    The REQUIRED access key to authenticate with. If it's not specified with the resource, you must provide its value by

    • configuring the obj_access_key in the provider configuration;
    • or, opting-in generating it implicitly at apply-time using obj_use_temp_keys at provider-level.
    acl string
    The canned ACL to apply. (private, public-read, authenticated-read, public-read-write, custom) (defaults to private).
    bucket string
    The name of the bucket to put the object in.
    cacheControl string
    Specifies caching behavior along the request/reply chain Read w3c cache_control for further details.
    cluster string
    The cluster the bucket is in.
    content string
    Literal string value to use as the object content, which will be uploaded as UTF-8-encoded text.
    contentBase64 string
    Base64-encoded data that will be decoded and uploaded as raw bytes for the object content. This allows safely uploading non-UTF8 binary data, but is recommended only for small content such as the result of the gzipbase64 function with small text strings. For larger objects, use source to stream the content from a disk file.
    contentDisposition string
    Specifies presentational information for the object. Read w3c content_disposition for further information.
    contentEncoding string
    Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. Read w3c content encoding for further information.
    contentLanguage string
    The language the content is in e.g. en-US or en-GB.
    contentType string
    A standard MIME type describing the format of the object data, e.g. application/octet-stream. All Valid MIME Types are valid for this input.
    endpoint string
    Used with the s3 client to make bucket changes and will be computed automatically if left blank, override for testing/debug purposes.
    etag string
    The specific version of this object.
    forceDestroy boolean
    Allow the object to be deleted regardless of any legal hold or object lock (defaults to false).
    key string
    They name of the object once it is in the bucket.
    metadata {[key: string]: string}
    A map of keys/values to provision metadata.
    secretKey string
    The REQUIRED secret key to authenticate with. If it's not specified with the resource, you must provide its value by

    • configuring the obj_secret_key in the provider configuration;
    • or, opting-in generating it implicitly at apply-time using obj_use_temp_keys at provider-level.
    source string
    The path to a file that will be read and uploaded as raw bytes for the object content. The path must either be relative to the root module or absolute.
    versionId string
    A unique version ID value for the object.
    websiteRedirect string
    Specifies a target URL for website redirect.
    access_key str
    The REQUIRED access key to authenticate with. If it's not specified with the resource, you must provide its value by

    • configuring the obj_access_key in the provider configuration;
    • or, opting-in generating it implicitly at apply-time using obj_use_temp_keys at provider-level.
    acl str
    The canned ACL to apply. (private, public-read, authenticated-read, public-read-write, custom) (defaults to private).
    bucket str
    The name of the bucket to put the object in.
    cache_control str
    Specifies caching behavior along the request/reply chain Read w3c cache_control for further details.
    cluster str
    The cluster the bucket is in.
    content str
    Literal string value to use as the object content, which will be uploaded as UTF-8-encoded text.
    content_base64 str
    Base64-encoded data that will be decoded and uploaded as raw bytes for the object content. This allows safely uploading non-UTF8 binary data, but is recommended only for small content such as the result of the gzipbase64 function with small text strings. For larger objects, use source to stream the content from a disk file.
    content_disposition str
    Specifies presentational information for the object. Read w3c content_disposition for further information.
    content_encoding str
    Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. Read w3c content encoding for further information.
    content_language str
    The language the content is in e.g. en-US or en-GB.
    content_type str
    A standard MIME type describing the format of the object data, e.g. application/octet-stream. All Valid MIME Types are valid for this input.
    endpoint str
    Used with the s3 client to make bucket changes and will be computed automatically if left blank, override for testing/debug purposes.
    etag str
    The specific version of this object.
    force_destroy bool
    Allow the object to be deleted regardless of any legal hold or object lock (defaults to false).
    key str
    They name of the object once it is in the bucket.
    metadata Mapping[str, str]
    A map of keys/values to provision metadata.
    secret_key str
    The REQUIRED secret key to authenticate with. If it's not specified with the resource, you must provide its value by

    • configuring the obj_secret_key in the provider configuration;
    • or, opting-in generating it implicitly at apply-time using obj_use_temp_keys at provider-level.
    source str
    The path to a file that will be read and uploaded as raw bytes for the object content. The path must either be relative to the root module or absolute.
    version_id str
    A unique version ID value for the object.
    website_redirect str
    Specifies a target URL for website redirect.
    accessKey String
    The REQUIRED access key to authenticate with. If it's not specified with the resource, you must provide its value by

    • configuring the obj_access_key in the provider configuration;
    • or, opting-in generating it implicitly at apply-time using obj_use_temp_keys at provider-level.
    acl String
    The canned ACL to apply. (private, public-read, authenticated-read, public-read-write, custom) (defaults to private).
    bucket String
    The name of the bucket to put the object in.
    cacheControl String
    Specifies caching behavior along the request/reply chain Read w3c cache_control for further details.
    cluster String
    The cluster the bucket is in.
    content String
    Literal string value to use as the object content, which will be uploaded as UTF-8-encoded text.
    contentBase64 String
    Base64-encoded data that will be decoded and uploaded as raw bytes for the object content. This allows safely uploading non-UTF8 binary data, but is recommended only for small content such as the result of the gzipbase64 function with small text strings. For larger objects, use source to stream the content from a disk file.
    contentDisposition String
    Specifies presentational information for the object. Read w3c content_disposition for further information.
    contentEncoding String
    Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. Read w3c content encoding for further information.
    contentLanguage String
    The language the content is in e.g. en-US or en-GB.
    contentType String
    A standard MIME type describing the format of the object data, e.g. application/octet-stream. All Valid MIME Types are valid for this input.
    endpoint String
    Used with the s3 client to make bucket changes and will be computed automatically if left blank, override for testing/debug purposes.
    etag String
    The specific version of this object.
    forceDestroy Boolean
    Allow the object to be deleted regardless of any legal hold or object lock (defaults to false).
    key String
    They name of the object once it is in the bucket.
    metadata Map<String>
    A map of keys/values to provision metadata.
    secretKey String
    The REQUIRED secret key to authenticate with. If it's not specified with the resource, you must provide its value by

    • configuring the obj_secret_key in the provider configuration;
    • or, opting-in generating it implicitly at apply-time using obj_use_temp_keys at provider-level.
    source String
    The path to a file that will be read and uploaded as raw bytes for the object content. The path must either be relative to the root module or absolute.
    versionId String
    A unique version ID value for the object.
    websiteRedirect String
    Specifies a target URL for website redirect.

    Package Details

    Repository
    Linode pulumi/pulumi-linode
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the linode Terraform Provider.
    linode logo
    Linode v4.22.1 published on Wednesday, Jul 3, 2024 by Pulumi