Oracle Cloud Infrastructure v2.17.0, Nov 15 24

Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

oci.ObjectStorage.StorageObject

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

Example Usage

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

const testObject = new oci.objectstorage.StorageObject("test_object", {
    bucket: objectBucket,
    content: objectContent,
    namespace: objectNamespace,
    object: objectObject,
    cacheControl: objectCacheControl,
    contentDisposition: objectContentDisposition,
    contentEncoding: objectContentEncoding,
    contentLanguage: objectContentLanguage,
    contentType: objectContentType,
    deleteAllObjectVersions: objectDeleteAllObjectVersions,
    metadata: objectMetadata,
    storageTier: objectStorageTier,
    opcSseKmsKeyId: objectOpcSseKmsKeyId,
});

import pulumi
import pulumi_oci as oci

test_object = oci.object_storage.StorageObject("test_object",
    bucket=object_bucket,
    content=object_content,
    namespace=object_namespace,
    object=object_object,
    cache_control=object_cache_control,
    content_disposition=object_content_disposition,
    content_encoding=object_content_encoding,
    content_language=object_content_language,
    content_type=object_content_type,
    delete_all_object_versions=object_delete_all_object_versions,
    metadata=object_metadata,
    storage_tier=object_storage_tier,
    opc_sse_kms_key_id=object_opc_sse_kms_key_id)

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/ObjectStorage"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ObjectStorage.NewStorageObject(ctx, "test_object", &ObjectStorage.StorageObjectArgs{
			Bucket:                  pulumi.Any(objectBucket),
			Content:                 pulumi.Any(objectContent),
			Namespace:               pulumi.Any(objectNamespace),
			Object:                  pulumi.Any(objectObject),
			CacheControl:            pulumi.Any(objectCacheControl),
			ContentDisposition:      pulumi.Any(objectContentDisposition),
			ContentEncoding:         pulumi.Any(objectContentEncoding),
			ContentLanguage:         pulumi.Any(objectContentLanguage),
			ContentType:             pulumi.Any(objectContentType),
			DeleteAllObjectVersions: pulumi.Any(objectDeleteAllObjectVersions),
			Metadata:                pulumi.Any(objectMetadata),
			StorageTier:             pulumi.Any(objectStorageTier),
			OpcSseKmsKeyId:          pulumi.Any(objectOpcSseKmsKeyId),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testObject = new Oci.ObjectStorage.StorageObject("test_object", new()
    {
        Bucket = objectBucket,
        Content = objectContent,
        Namespace = objectNamespace,
        Object = objectObject,
        CacheControl = objectCacheControl,
        ContentDisposition = objectContentDisposition,
        ContentEncoding = objectContentEncoding,
        ContentLanguage = objectContentLanguage,
        ContentType = objectContentType,
        DeleteAllObjectVersions = objectDeleteAllObjectVersions,
        Metadata = objectMetadata,
        StorageTier = objectStorageTier,
        OpcSseKmsKeyId = objectOpcSseKmsKeyId,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.ObjectStorage.StorageObject;
import com.pulumi.oci.ObjectStorage.StorageObjectArgs;
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 testObject = new StorageObject("testObject", StorageObjectArgs.builder()
            .bucket(objectBucket)
            .content(objectContent)
            .namespace(objectNamespace)
            .object(objectObject)
            .cacheControl(objectCacheControl)
            .contentDisposition(objectContentDisposition)
            .contentEncoding(objectContentEncoding)
            .contentLanguage(objectContentLanguage)
            .contentType(objectContentType)
            .deleteAllObjectVersions(objectDeleteAllObjectVersions)
            .metadata(objectMetadata)
            .storageTier(objectStorageTier)
            .opcSseKmsKeyId(objectOpcSseKmsKeyId)
            .build());

    }
}

resources:
  testObject:
    type: oci:ObjectStorage:StorageObject
    name: test_object
    properties:
      bucket: ${objectBucket}
      content: ${objectContent}
      namespace: ${objectNamespace}
      object: ${objectObject}
      cacheControl: ${objectCacheControl}
      contentDisposition: ${objectContentDisposition}
      contentEncoding: ${objectContentEncoding}
      contentLanguage: ${objectContentLanguage}
      contentType: ${objectContentType}
      deleteAllObjectVersions: ${objectDeleteAllObjectVersions}
      metadata: ${objectMetadata}
      storageTier: ${objectStorageTier}
      opcSseKmsKeyId: ${objectOpcSseKmsKeyId}

Create StorageObject Resource

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

Constructor syntax

new StorageObject(name: string, args: StorageObjectArgs, opts?: CustomResourceOptions);

@overload
def StorageObject(resource_name: str,
                  args: StorageObjectArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def StorageObject(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  bucket: Optional[str] = None,
                  object: Optional[str] = None,
                  namespace: Optional[str] = None,
                  delete_all_object_versions: Optional[bool] = None,
                  content_encoding: Optional[str] = None,
                  content_language: Optional[str] = None,
                  content_md5: Optional[str] = None,
                  content_type: Optional[str] = None,
                  content_disposition: Optional[str] = None,
                  metadata: Optional[Mapping[str, str]] = None,
                  content: Optional[str] = None,
                  cache_control: Optional[str] = None,
                  opc_sse_kms_key_id: Optional[str] = None,
                  source: Optional[str] = None,
                  source_uri_details: Optional[_objectstorage.StorageObjectSourceUriDetailsArgs] = None,
                  storage_tier: Optional[str] = None)

func NewStorageObject(ctx *Context, name string, args StorageObjectArgs, opts ...ResourceOption) (*StorageObject, error)

public StorageObject(string name, StorageObjectArgs args, CustomResourceOptions? opts = null)

public StorageObject(String name, StorageObjectArgs args)
public StorageObject(String name, StorageObjectArgs args, CustomResourceOptions options)

type: oci:ObjectStorage:StorageObject
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 StorageObjectArgs: 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 StorageObjectArgs: 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 StorageObjectArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args StorageObjectArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args StorageObjectArgs: 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 storageObjectResource = new Oci.ObjectStorage.StorageObject("storageObjectResource", new()
{
    Bucket = "string",
    Object = "string",
    Namespace = "string",
    DeleteAllObjectVersions = false,
    ContentEncoding = "string",
    ContentLanguage = "string",
    ContentMd5 = "string",
    ContentType = "string",
    ContentDisposition = "string",
    Metadata = 
    {
        { "string", "string" },
    },
    Content = "string",
    CacheControl = "string",
    OpcSseKmsKeyId = "string",
    Source = "string",
    SourceUriDetails = new Oci.ObjectStorage.Inputs.StorageObjectSourceUriDetailsArgs
    {
        Bucket = "string",
        Namespace = "string",
        Object = "string",
        Region = "string",
        DestinationObjectIfMatchEtag = "string",
        DestinationObjectIfNoneMatchEtag = "string",
        SourceObjectIfMatchEtag = "string",
        SourceVersionId = "string",
    },
    StorageTier = "string",
});

example, err := ObjectStorage.NewStorageObject(ctx, "storageObjectResource", &ObjectStorage.StorageObjectArgs{
	Bucket:                  pulumi.String("string"),
	Object:                  pulumi.String("string"),
	Namespace:               pulumi.String("string"),
	DeleteAllObjectVersions: pulumi.Bool(false),
	ContentEncoding:         pulumi.String("string"),
	ContentLanguage:         pulumi.String("string"),
	ContentMd5:              pulumi.String("string"),
	ContentType:             pulumi.String("string"),
	ContentDisposition:      pulumi.String("string"),
	Metadata: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Content:        pulumi.String("string"),
	CacheControl:   pulumi.String("string"),
	OpcSseKmsKeyId: pulumi.String("string"),
	Source:         pulumi.String("string"),
	SourceUriDetails: &objectstorage.StorageObjectSourceUriDetailsArgs{
		Bucket:                           pulumi.String("string"),
		Namespace:                        pulumi.String("string"),
		Object:                           pulumi.String("string"),
		Region:                           pulumi.String("string"),
		DestinationObjectIfMatchEtag:     pulumi.String("string"),
		DestinationObjectIfNoneMatchEtag: pulumi.String("string"),
		SourceObjectIfMatchEtag:          pulumi.String("string"),
		SourceVersionId:                  pulumi.String("string"),
	},
	StorageTier: pulumi.String("string"),
})

var storageObjectResource = new StorageObject("storageObjectResource", StorageObjectArgs.builder()
    .bucket("string")
    .object("string")
    .namespace("string")
    .deleteAllObjectVersions(false)
    .contentEncoding("string")
    .contentLanguage("string")
    .contentMd5("string")
    .contentType("string")
    .contentDisposition("string")
    .metadata(Map.of("string", "string"))
    .content("string")
    .cacheControl("string")
    .opcSseKmsKeyId("string")
    .source("string")
    .sourceUriDetails(StorageObjectSourceUriDetailsArgs.builder()
        .bucket("string")
        .namespace("string")
        .object("string")
        .region("string")
        .destinationObjectIfMatchEtag("string")
        .destinationObjectIfNoneMatchEtag("string")
        .sourceObjectIfMatchEtag("string")
        .sourceVersionId("string")
        .build())
    .storageTier("string")
    .build());

storage_object_resource = oci.object_storage.StorageObject("storageObjectResource",
    bucket="string",
    object="string",
    namespace="string",
    delete_all_object_versions=False,
    content_encoding="string",
    content_language="string",
    content_md5="string",
    content_type="string",
    content_disposition="string",
    metadata={
        "string": "string",
    },
    content="string",
    cache_control="string",
    opc_sse_kms_key_id="string",
    source="string",
    source_uri_details={
        "bucket": "string",
        "namespace": "string",
        "object": "string",
        "region": "string",
        "destination_object_if_match_etag": "string",
        "destination_object_if_none_match_etag": "string",
        "source_object_if_match_etag": "string",
        "source_version_id": "string",
    },
    storage_tier="string")

const storageObjectResource = new oci.objectstorage.StorageObject("storageObjectResource", {
    bucket: "string",
    object: "string",
    namespace: "string",
    deleteAllObjectVersions: false,
    contentEncoding: "string",
    contentLanguage: "string",
    contentMd5: "string",
    contentType: "string",
    contentDisposition: "string",
    metadata: {
        string: "string",
    },
    content: "string",
    cacheControl: "string",
    opcSseKmsKeyId: "string",
    source: "string",
    sourceUriDetails: {
        bucket: "string",
        namespace: "string",
        object: "string",
        region: "string",
        destinationObjectIfMatchEtag: "string",
        destinationObjectIfNoneMatchEtag: "string",
        sourceObjectIfMatchEtag: "string",
        sourceVersionId: "string",
    },
    storageTier: "string",
});

type: oci:ObjectStorage:StorageObject
properties:
    bucket: string
    cacheControl: string
    content: string
    contentDisposition: string
    contentEncoding: string
    contentLanguage: string
    contentMd5: string
    contentType: string
    deleteAllObjectVersions: false
    metadata:
        string: string
    namespace: string
    object: string
    opcSseKmsKeyId: string
    source: string
    sourceUriDetails:
        bucket: string
        destinationObjectIfMatchEtag: string
        destinationObjectIfNoneMatchEtag: string
        namespace: string
        object: string
        region: string
        sourceObjectIfMatchEtag: string
        sourceVersionId: string
    storageTier: string

StorageObject Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The StorageObject resource accepts the following input properties:

Bucket string

The name of the bucket. Avoid entering confidential information. Example: my-new-bucket1

Namespace string

The Object Storage namespace used for the request.

Object string

(Updatable) The name of the object. Avoid entering confidential information. Example: test/object1.log

CacheControl string

The optional Cache-Control header that defines the caching behavior value to be returned in GetObject and HeadObject responses. Specifying values for this header has no effect on Object Storage behavior. Programs that read the object determine what to do based on the value provided. For example, you could use this header to identify objects that require caching restrictions.

Content string

The object to upload to the object store. Cannot be defined if source or source_uri_details is defined.

ContentDisposition string

The optional Content-Disposition header that defines presentational information for the object to be returned in GetObject and HeadObject responses. Specifying values for this header has no effect on Object Storage behavior. Programs that read the object determine what to do based on the value provided. For example, you could use this header to let users download objects with custom filenames in a browser.

ContentEncoding string

The optional Content-Encoding header that defines the content encodings that were applied to the object to upload. Specifying values for this header has no effect on Object Storage behavior. Programs that read the object determine what to do based on the value provided. For example, you could use this header to determine what decoding mechanisms need to be applied to obtain the media-type specified by the Content-Type header of the object.

ContentLanguage string

The optional Content-Language header that defines the content language of the object to upload. Specifying values for this header has no effect on Object Storage behavior. Programs that read the object determine what to do based on the value provided. For example, you could use this header to identify and differentiate objects based on a particular language.

ContentMd5 string

(Updatable) The optional header that defines the base64-encoded MD5 hash of the body. If the optional Content-MD5 header is present, Object Storage performs an integrity check on the body of the HTTP request by computing the MD5 hash for the body and comparing it to the MD5 hash supplied in the header. If the two hashes do not match, the object is rejected and an HTTP-400 Unmatched Content MD5 error is returned with the message:

"The computed MD5 of the request body (ACTUAL_MD5) does not match the Content-MD5 header (HEADER_MD5)"

ContentType string

The optional Content-Type header that defines the standard MIME type format of the object. Content type defaults to 'application/octet-stream' if not specified in the PutObject call. Specifying values for this header has no effect on Object Storage behavior. Programs that read the object determine what to do based on the value provided. For example, you could use this header to identify and perform special operations on text only objects.

DeleteAllObjectVersions bool

(Updatable) A boolean to delete all object versions for an object in a bucket that has or ever had versioning enabled.

Metadata Dictionary<string, string>

Optional user-defined metadata key and value. Note: All specified keys must be in lower case.

OpcSseKmsKeyId string

(Updatable) The OCID of a master encryption key used to call the Key Management service to generate a data encryption key or to encrypt or decrypt a data encryption key.

Source string

An absolute path to a file on the local system. Cannot be defined if content or source_uri_details is defined.

SourceUriDetails StorageObjectSourceUriDetails

Details of the source URI of the object in the cloud. Cannot be defined if content or source is defined. Note: To enable object copy, you must authorize the service to manage objects on your behalf.

StorageTier string

(Updatable) The storage tier that the object should be stored in. If not specified, the object will be stored in the same storage tier as the bucket.

Bucket string

The name of the bucket. Avoid entering confidential information. Example: my-new-bucket1

Namespace string

The Object Storage namespace used for the request.

Object string

(Updatable) The name of the object. Avoid entering confidential information. Example: test/object1.log

CacheControl string

Content string

The object to upload to the object store. Cannot be defined if source or source_uri_details is defined.

ContentDisposition string

ContentEncoding string

ContentLanguage string

ContentMd5 string

"The computed MD5 of the request body (ACTUAL_MD5) does not match the Content-MD5 header (HEADER_MD5)"

ContentType string

DeleteAllObjectVersions bool

(Updatable) A boolean to delete all object versions for an object in a bucket that has or ever had versioning enabled.

Metadata map[string]string

Optional user-defined metadata key and value. Note: All specified keys must be in lower case.

OpcSseKmsKeyId string

(Updatable) The OCID of a master encryption key used to call the Key Management service to generate a data encryption key or to encrypt or decrypt a data encryption key.

Source string

An absolute path to a file on the local system. Cannot be defined if content or source_uri_details is defined.

SourceUriDetails StorageObjectSourceUriDetailsArgs

StorageTier string

(Updatable) The storage tier that the object should be stored in. If not specified, the object will be stored in the same storage tier as the bucket.

bucket String

The name of the bucket. Avoid entering confidential information. Example: my-new-bucket1

namespace String

The Object Storage namespace used for the request.

object String

(Updatable) The name of the object. Avoid entering confidential information. Example: test/object1.log

cacheControl String

content String

The object to upload to the object store. Cannot be defined if source or source_uri_details is defined.

contentDisposition String

contentEncoding String

contentLanguage String

contentMd5 String

"The computed MD5 of the request body (ACTUAL_MD5) does not match the Content-MD5 header (HEADER_MD5)"

contentType String

deleteAllObjectVersions Boolean

(Updatable) A boolean to delete all object versions for an object in a bucket that has or ever had versioning enabled.

metadata Map<String,String>

Optional user-defined metadata key and value. Note: All specified keys must be in lower case.

opcSseKmsKeyId String

(Updatable) The OCID of a master encryption key used to call the Key Management service to generate a data encryption key or to encrypt or decrypt a data encryption key.

source String

An absolute path to a file on the local system. Cannot be defined if content or source_uri_details is defined.

sourceUriDetails StorageObjectSourceUriDetails

storageTier String

(Updatable) The storage tier that the object should be stored in. If not specified, the object will be stored in the same storage tier as the bucket.

bucket string

The name of the bucket. Avoid entering confidential information. Example: my-new-bucket1

namespace string

The Object Storage namespace used for the request.

object string

(Updatable) The name of the object. Avoid entering confidential information. Example: test/object1.log

cacheControl string

content string

The object to upload to the object store. Cannot be defined if source or source_uri_details is defined.

contentDisposition string

contentEncoding string

contentLanguage string

contentMd5 string

"The computed MD5 of the request body (ACTUAL_MD5) does not match the Content-MD5 header (HEADER_MD5)"

contentType string

deleteAllObjectVersions boolean

(Updatable) A boolean to delete all object versions for an object in a bucket that has or ever had versioning enabled.

metadata {[key: string]: string}

Optional user-defined metadata key and value. Note: All specified keys must be in lower case.

opcSseKmsKeyId string

(Updatable) The OCID of a master encryption key used to call the Key Management service to generate a data encryption key or to encrypt or decrypt a data encryption key.

source string

An absolute path to a file on the local system. Cannot be defined if content or source_uri_details is defined.

sourceUriDetails StorageObjectSourceUriDetails

storageTier string

(Updatable) The storage tier that the object should be stored in. If not specified, the object will be stored in the same storage tier as the bucket.

bucket str

The name of the bucket. Avoid entering confidential information. Example: my-new-bucket1

namespace str

The Object Storage namespace used for the request.

object str

(Updatable) The name of the object. Avoid entering confidential information. Example: test/object1.log

cache_control str

content str

The object to upload to the object store. Cannot be defined if source or source_uri_details is defined.

content_disposition str

content_encoding str

content_language str

content_md5 str

"The computed MD5 of the request body (ACTUAL_MD5) does not match the Content-MD5 header (HEADER_MD5)"

content_type str

delete_all_object_versions bool

(Updatable) A boolean to delete all object versions for an object in a bucket that has or ever had versioning enabled.

metadata Mapping[str, str]

Optional user-defined metadata key and value. Note: All specified keys must be in lower case.

opc_sse_kms_key_id str

(Updatable) The OCID of a master encryption key used to call the Key Management service to generate a data encryption key or to encrypt or decrypt a data encryption key.

source str

An absolute path to a file on the local system. Cannot be defined if content or source_uri_details is defined.

source_uri_details objectstorage.StorageObjectSourceUriDetailsArgs

storage_tier str

(Updatable) The storage tier that the object should be stored in. If not specified, the object will be stored in the same storage tier as the bucket.

bucket String

The name of the bucket. Avoid entering confidential information. Example: my-new-bucket1

namespace String

The Object Storage namespace used for the request.

object String

(Updatable) The name of the object. Avoid entering confidential information. Example: test/object1.log

cacheControl String

content String

The object to upload to the object store. Cannot be defined if source or source_uri_details is defined.

contentDisposition String

contentEncoding String

contentLanguage String

contentMd5 String

"The computed MD5 of the request body (ACTUAL_MD5) does not match the Content-MD5 header (HEADER_MD5)"

contentType String

deleteAllObjectVersions Boolean

(Updatable) A boolean to delete all object versions for an object in a bucket that has or ever had versioning enabled.

metadata Map<String>

Optional user-defined metadata key and value. Note: All specified keys must be in lower case.

opcSseKmsKeyId String

(Updatable) The OCID of a master encryption key used to call the Key Management service to generate a data encryption key or to encrypt or decrypt a data encryption key.

source String

An absolute path to a file on the local system. Cannot be defined if content or source_uri_details is defined.

sourceUriDetails Property Map

storageTier String

(Updatable) The storage tier that the object should be stored in. If not specified, the object will be stored in the same storage tier as the bucket.

Outputs

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

ContentLength string: (Updatable) The content length of the body.
Id string: The provider-assigned unique ID for this managed resource.
State string
VersionId string
WorkRequestId string

ContentLength string: (Updatable) The content length of the body.
Id string: The provider-assigned unique ID for this managed resource.
State string
VersionId string
WorkRequestId string

contentLength String: (Updatable) The content length of the body.
id String: The provider-assigned unique ID for this managed resource.
state String
versionId String
workRequestId String

contentLength string: (Updatable) The content length of the body.
id string: The provider-assigned unique ID for this managed resource.
state string
versionId string
workRequestId string

content_length str: (Updatable) The content length of the body.
id str: The provider-assigned unique ID for this managed resource.
state str
version_id str
work_request_id str

contentLength String: (Updatable) The content length of the body.
id String: The provider-assigned unique ID for this managed resource.
state String
versionId String
workRequestId String

Look up Existing StorageObject Resource

Get an existing StorageObject 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?: StorageObjectState, opts?: CustomResourceOptions): StorageObject

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        bucket: Optional[str] = None,
        cache_control: Optional[str] = None,
        content: Optional[str] = None,
        content_disposition: Optional[str] = None,
        content_encoding: Optional[str] = None,
        content_language: Optional[str] = None,
        content_length: Optional[str] = None,
        content_md5: Optional[str] = None,
        content_type: Optional[str] = None,
        delete_all_object_versions: Optional[bool] = None,
        metadata: Optional[Mapping[str, str]] = None,
        namespace: Optional[str] = None,
        object: Optional[str] = None,
        opc_sse_kms_key_id: Optional[str] = None,
        source: Optional[str] = None,
        source_uri_details: Optional[_objectstorage.StorageObjectSourceUriDetailsArgs] = None,
        state: Optional[str] = None,
        storage_tier: Optional[str] = None,
        version_id: Optional[str] = None,
        work_request_id: Optional[str] = None) -> StorageObject

func GetStorageObject(ctx *Context, name string, id IDInput, state *StorageObjectState, opts ...ResourceOption) (*StorageObject, error)

public static StorageObject Get(string name, Input<string> id, StorageObjectState? state, CustomResourceOptions? opts = null)

public static StorageObject get(String name, Output<String> id, StorageObjectState 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:

Bucket string

The name of the bucket. Avoid entering confidential information. Example: my-new-bucket1

CacheControl string

Content string

The object to upload to the object store. Cannot be defined if source or source_uri_details is defined.

ContentDisposition string

ContentEncoding string

ContentLanguage string

ContentLength string

(Updatable) The content length of the body.

ContentMd5 string

"The computed MD5 of the request body (ACTUAL_MD5) does not match the Content-MD5 header (HEADER_MD5)"

ContentType string

DeleteAllObjectVersions bool

(Updatable) A boolean to delete all object versions for an object in a bucket that has or ever had versioning enabled.

Metadata Dictionary<string, string>

Optional user-defined metadata key and value. Note: All specified keys must be in lower case.

Namespace string

The Object Storage namespace used for the request.

Object string

(Updatable) The name of the object. Avoid entering confidential information. Example: test/object1.log

OpcSseKmsKeyId string

(Updatable) The OCID of a master encryption key used to call the Key Management service to generate a data encryption key or to encrypt or decrypt a data encryption key.

Source string

An absolute path to a file on the local system. Cannot be defined if content or source_uri_details is defined.

SourceUriDetails StorageObjectSourceUriDetails

State string

StorageTier string

(Updatable) The storage tier that the object should be stored in. If not specified, the object will be stored in the same storage tier as the bucket.

VersionId string

WorkRequestId string

Bucket string

The name of the bucket. Avoid entering confidential information. Example: my-new-bucket1

CacheControl string

Content string

The object to upload to the object store. Cannot be defined if source or source_uri_details is defined.

ContentDisposition string

ContentEncoding string

ContentLanguage string

ContentLength string

(Updatable) The content length of the body.

ContentMd5 string

"The computed MD5 of the request body (ACTUAL_MD5) does not match the Content-MD5 header (HEADER_MD5)"

ContentType string

DeleteAllObjectVersions bool

(Updatable) A boolean to delete all object versions for an object in a bucket that has or ever had versioning enabled.

Metadata map[string]string

Optional user-defined metadata key and value. Note: All specified keys must be in lower case.

Namespace string

The Object Storage namespace used for the request.

Object string

(Updatable) The name of the object. Avoid entering confidential information. Example: test/object1.log

OpcSseKmsKeyId string

(Updatable) The OCID of a master encryption key used to call the Key Management service to generate a data encryption key or to encrypt or decrypt a data encryption key.

Source string

An absolute path to a file on the local system. Cannot be defined if content or source_uri_details is defined.

SourceUriDetails StorageObjectSourceUriDetailsArgs

State string

StorageTier string

(Updatable) The storage tier that the object should be stored in. If not specified, the object will be stored in the same storage tier as the bucket.

VersionId string

WorkRequestId string

bucket String

The name of the bucket. Avoid entering confidential information. Example: my-new-bucket1

cacheControl String

content String

The object to upload to the object store. Cannot be defined if source or source_uri_details is defined.

contentDisposition String

contentEncoding String

contentLanguage String

contentLength String

(Updatable) The content length of the body.

contentMd5 String

"The computed MD5 of the request body (ACTUAL_MD5) does not match the Content-MD5 header (HEADER_MD5)"

contentType String

deleteAllObjectVersions Boolean

(Updatable) A boolean to delete all object versions for an object in a bucket that has or ever had versioning enabled.

metadata Map<String,String>

Optional user-defined metadata key and value. Note: All specified keys must be in lower case.

namespace String

The Object Storage namespace used for the request.

object String

(Updatable) The name of the object. Avoid entering confidential information. Example: test/object1.log

opcSseKmsKeyId String

(Updatable) The OCID of a master encryption key used to call the Key Management service to generate a data encryption key or to encrypt or decrypt a data encryption key.

source String

An absolute path to a file on the local system. Cannot be defined if content or source_uri_details is defined.

sourceUriDetails StorageObjectSourceUriDetails

state String

storageTier String

(Updatable) The storage tier that the object should be stored in. If not specified, the object will be stored in the same storage tier as the bucket.

versionId String

workRequestId String

bucket string

The name of the bucket. Avoid entering confidential information. Example: my-new-bucket1

cacheControl string

content string

The object to upload to the object store. Cannot be defined if source or source_uri_details is defined.

contentDisposition string

contentEncoding string

contentLanguage string

contentLength string

(Updatable) The content length of the body.

contentMd5 string

"The computed MD5 of the request body (ACTUAL_MD5) does not match the Content-MD5 header (HEADER_MD5)"

contentType string

deleteAllObjectVersions boolean

(Updatable) A boolean to delete all object versions for an object in a bucket that has or ever had versioning enabled.

metadata {[key: string]: string}

Optional user-defined metadata key and value. Note: All specified keys must be in lower case.

namespace string

The Object Storage namespace used for the request.

object string

(Updatable) The name of the object. Avoid entering confidential information. Example: test/object1.log

opcSseKmsKeyId string

(Updatable) The OCID of a master encryption key used to call the Key Management service to generate a data encryption key or to encrypt or decrypt a data encryption key.

source string

An absolute path to a file on the local system. Cannot be defined if content or source_uri_details is defined.

sourceUriDetails StorageObjectSourceUriDetails

state string

storageTier string

(Updatable) The storage tier that the object should be stored in. If not specified, the object will be stored in the same storage tier as the bucket.

versionId string

workRequestId string

bucket str

The name of the bucket. Avoid entering confidential information. Example: my-new-bucket1

cache_control str

content str

The object to upload to the object store. Cannot be defined if source or source_uri_details is defined.

content_disposition str

content_encoding str

content_language str

content_length str

(Updatable) The content length of the body.

content_md5 str

"The computed MD5 of the request body (ACTUAL_MD5) does not match the Content-MD5 header (HEADER_MD5)"

content_type str

delete_all_object_versions bool

(Updatable) A boolean to delete all object versions for an object in a bucket that has or ever had versioning enabled.

metadata Mapping[str, str]

Optional user-defined metadata key and value. Note: All specified keys must be in lower case.

namespace str

The Object Storage namespace used for the request.

object str

(Updatable) The name of the object. Avoid entering confidential information. Example: test/object1.log

opc_sse_kms_key_id str

(Updatable) The OCID of a master encryption key used to call the Key Management service to generate a data encryption key or to encrypt or decrypt a data encryption key.

source str

An absolute path to a file on the local system. Cannot be defined if content or source_uri_details is defined.

source_uri_details objectstorage.StorageObjectSourceUriDetailsArgs

state str

storage_tier str

(Updatable) The storage tier that the object should be stored in. If not specified, the object will be stored in the same storage tier as the bucket.

version_id str

work_request_id str

bucket String

The name of the bucket. Avoid entering confidential information. Example: my-new-bucket1

cacheControl String

content String

The object to upload to the object store. Cannot be defined if source or source_uri_details is defined.

contentDisposition String

contentEncoding String

contentLanguage String

contentLength String

(Updatable) The content length of the body.

contentMd5 String

"The computed MD5 of the request body (ACTUAL_MD5) does not match the Content-MD5 header (HEADER_MD5)"

contentType String

deleteAllObjectVersions Boolean

(Updatable) A boolean to delete all object versions for an object in a bucket that has or ever had versioning enabled.

metadata Map<String>

Optional user-defined metadata key and value. Note: All specified keys must be in lower case.

namespace String

The Object Storage namespace used for the request.

object String

(Updatable) The name of the object. Avoid entering confidential information. Example: test/object1.log

opcSseKmsKeyId String

(Updatable) The OCID of a master encryption key used to call the Key Management service to generate a data encryption key or to encrypt or decrypt a data encryption key.

source String

An absolute path to a file on the local system. Cannot be defined if content or source_uri_details is defined.

sourceUriDetails Property Map

state String

storageTier String

(Updatable) The storage tier that the object should be stored in. If not specified, the object will be stored in the same storage tier as the bucket.

versionId String

workRequestId String

Supporting Types

StorageObjectSourceUriDetails, StorageObjectSourceUriDetailsArgs

Bucket string

The name of the bucket for the source object.

Namespace string

The top-level namespace of the source object.

Object string

The name of the source object.

Region string

The region of the source object.

DestinationObjectIfMatchEtag string

The entity tag to match the target object.

DestinationObjectIfNoneMatchEtag string

The entity tag to not match the target object.

SourceObjectIfMatchEtag string

The entity tag to match the source object.

SourceVersionId string

The version id of the object to be restored.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

Bucket string

The name of the bucket for the source object.

Namespace string

The top-level namespace of the source object.

Object string

The name of the source object.

Region string

The region of the source object.

DestinationObjectIfMatchEtag string

The entity tag to match the target object.

DestinationObjectIfNoneMatchEtag string

The entity tag to not match the target object.

SourceObjectIfMatchEtag string

The entity tag to match the source object.

SourceVersionId string

The version id of the object to be restored.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

bucket String

The name of the bucket for the source object.

namespace String

The top-level namespace of the source object.

object String

The name of the source object.

region String

The region of the source object.

destinationObjectIfMatchEtag String

The entity tag to match the target object.

destinationObjectIfNoneMatchEtag String

The entity tag to not match the target object.

sourceObjectIfMatchEtag String

The entity tag to match the source object.

sourceVersionId String

The version id of the object to be restored.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

bucket string

The name of the bucket for the source object.

namespace string

The top-level namespace of the source object.

object string

The name of the source object.

region string

The region of the source object.

destinationObjectIfMatchEtag string

The entity tag to match the target object.

destinationObjectIfNoneMatchEtag string

The entity tag to not match the target object.

sourceObjectIfMatchEtag string

The entity tag to match the source object.

sourceVersionId string

The version id of the object to be restored.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

bucket str

The name of the bucket for the source object.

namespace str

The top-level namespace of the source object.

object str

The name of the source object.

region str

The region of the source object.

destination_object_if_match_etag str

The entity tag to match the target object.

destination_object_if_none_match_etag str

The entity tag to not match the target object.

source_object_if_match_etag str

The entity tag to match the source object.

source_version_id str

The version id of the object to be restored.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

bucket String

The name of the bucket for the source object.

namespace String

The top-level namespace of the source object.

object String

The name of the source object.

region String

The region of the source object.

destinationObjectIfMatchEtag String

The entity tag to match the target object.

destinationObjectIfNoneMatchEtag String

The entity tag to not match the target object.

sourceObjectIfMatchEtag String

The entity tag to match the source object.

sourceVersionId String

The version id of the object to be restored.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

Import

Objects can be imported using the id, e.g.

$ pulumi import oci:ObjectStorage/storageObject:StorageObject test_object "n/{namespaceName}/b/{bucketName}/o/{objectName}"

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.

Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

pulumi/pulumi-oci

oci.ObjectStorage.StorageObject

On this page

On this page

Example Usage

Create StorageObject Resource

Constructor syntax

Parameters

Constructor example

StorageObject Resource Properties

Inputs

Outputs

Look up Existing StorageObject Resource

Supporting Types

StorageObjectSourceUriDetails, StorageObjectSourceUriDetailsArgs

Import

Package Details

On this page

On this page