import * as pulumi from "@pulumi/pulumi"; /** * Provides a bucket object resource for Spaces, DigitalOcean's object storage product. * The `digitalocean.SpacesBucketObject` resource allows the provider to upload content * to Spaces. * * The [Spaces API](https://docs.digitalocean.com/reference/api/spaces-api/) was * designed to be interoperable with Amazon's AWS S3 API. This allows users to * interact with the service while using the tools they already know. Spaces * mirrors S3's authentication framework and requests to Spaces require a key pair * similar to Amazon's Access ID and Secret Key. * * The authentication requirement can be met by either setting the * `SPACES_ACCESS_KEY_ID` and `SPACES_SECRET_ACCESS_KEY` environment variables or * the provider's `spacesAccessId` and `spacesSecretKey` arguments to the * access ID and secret you generate via the DigitalOcean control panel. For * example: * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as digitalocean from "@pulumi/digitalocean"; * * const static_assets = new digitalocean.SpacesBucket("static-assets", {}); * ``` * * For more information, See [An Introduction to DigitalOcean Spaces](https://www.digitalocean.com/community/tutorials/an-introduction-to-digitalocean-spaces) * * ## Example Usage * * ### Create a Key in a Spaces Bucket * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as digitalocean from "@pulumi/digitalocean"; * * const foobar = new digitalocean.SpacesBucket("foobar", { * name: "foobar", * region: digitalocean.Region.NYC3, * }); * const index = new digitalocean.SpacesBucketObject("index", { * region: foobar.region, * bucket: foobar.name, * key: "index.html", * content: "

This page is empty.

", * contentType: "text/html", * }); * ``` * * ## Import * * Importing this resource is not supported. */ export declare class SpacesBucketObject extends pulumi.CustomResource { /** * Get an existing SpacesBucketObject resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: SpacesBucketObjectState, opts?: pulumi.CustomResourceOptions): SpacesBucketObject; /** * Returns true if the given object is an instance of SpacesBucketObject. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is SpacesBucketObject; /** * The canned ACL to apply. DigitalOcean supports "private" and "public-read". (Defaults to "private".) */ readonly acl: pulumi.Output; /** * The name of the bucket to put the file in. */ readonly bucket: pulumi.Output; /** * Specifies caching behavior along the request/reply chain Read [w3c cacheControl](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9) for further details. */ readonly cacheControl: pulumi.Output; /** * Literal string value to use as the object content, which will be uploaded as UTF-8-encoded text. */ readonly content: pulumi.Output; /** * 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. */ readonly contentBase64: pulumi.Output; /** * Specifies presentational information for the object. Read [w3c contentDisposition](http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1) for further information. */ readonly contentDisposition: pulumi.Output; /** * 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](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11) for further information. */ readonly contentEncoding: pulumi.Output; /** * The language the content is in e.g. en-US or en-GB. */ readonly contentLanguage: pulumi.Output; /** * 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. */ readonly contentType: pulumi.Output; /** * Used to trigger updates. */ readonly etag: pulumi.Output; /** * Allow the object to be deleted by removing any legal hold on any object version. * Default is `false`. This value should be set to `true` only if the bucket has S3 object lock enabled. * * If no content is provided through `source`, `content` or `contentBase64`, then the object will be empty. * * > **Note:** The provider ignores all leading `/`s in the object's `key` and treats multiple `/`s in the rest of the object's `key` as a single `/`, so values of `/index.html` and `index.html` correspond to the same S3 object as do `first//second///third//` and `first/second/third/`. */ readonly forceDestroy: pulumi.Output; /** * The name of the object once it is in the bucket. */ readonly key: pulumi.Output; /** * A mapping of keys/values to provision metadata (will be automatically prefixed by `x-amz-meta-`, note that only lowercase label are currently supported by the AWS Go API). */ readonly metadata: pulumi.Output<{ [key: string]: string; } | undefined>; /** * The region where the bucket resides (Defaults to `nyc3`) */ readonly region: pulumi.Output; /** * The path to a file that will be read and uploaded as raw bytes for the object content. */ readonly source: pulumi.Output; /** * A unique version ID value for the object, if bucket versioning is enabled. */ readonly versionId: pulumi.Output; /** * Specifies a target URL for [website redirect](http://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html). */ readonly websiteRedirect: pulumi.Output; /** * Create a SpacesBucketObject resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: SpacesBucketObjectArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering SpacesBucketObject resources. */ export interface SpacesBucketObjectState { /** * The canned ACL to apply. DigitalOcean supports "private" and "public-read". (Defaults to "private".) */ acl?: pulumi.Input; /** * The name of the bucket to put the file in. */ bucket?: pulumi.Input; /** * Specifies caching behavior along the request/reply chain Read [w3c cacheControl](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9) for further details. */ cacheControl?: pulumi.Input; /** * Literal string value to use as the object content, which will be uploaded as UTF-8-encoded text. */ content?: pulumi.Input; /** * 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. */ contentBase64?: pulumi.Input; /** * Specifies presentational information for the object. Read [w3c contentDisposition](http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1) for further information. */ contentDisposition?: pulumi.Input; /** * 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](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11) for further information. */ contentEncoding?: pulumi.Input; /** * The language the content is in e.g. en-US or en-GB. */ contentLanguage?: pulumi.Input; /** * 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. */ contentType?: pulumi.Input; /** * Used to trigger updates. */ etag?: pulumi.Input; /** * Allow the object to be deleted by removing any legal hold on any object version. * Default is `false`. This value should be set to `true` only if the bucket has S3 object lock enabled. * * If no content is provided through `source`, `content` or `contentBase64`, then the object will be empty. * * > **Note:** The provider ignores all leading `/`s in the object's `key` and treats multiple `/`s in the rest of the object's `key` as a single `/`, so values of `/index.html` and `index.html` correspond to the same S3 object as do `first//second///third//` and `first/second/third/`. */ forceDestroy?: pulumi.Input; /** * The name of the object once it is in the bucket. */ key?: pulumi.Input; /** * A mapping of keys/values to provision metadata (will be automatically prefixed by `x-amz-meta-`, note that only lowercase label are currently supported by the AWS Go API). */ metadata?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * The region where the bucket resides (Defaults to `nyc3`) */ region?: pulumi.Input; /** * The path to a file that will be read and uploaded as raw bytes for the object content. */ source?: pulumi.Input; /** * A unique version ID value for the object, if bucket versioning is enabled. */ versionId?: pulumi.Input; /** * Specifies a target URL for [website redirect](http://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html). */ websiteRedirect?: pulumi.Input; } /** * The set of arguments for constructing a SpacesBucketObject resource. */ export interface SpacesBucketObjectArgs { /** * The canned ACL to apply. DigitalOcean supports "private" and "public-read". (Defaults to "private".) */ acl?: pulumi.Input; /** * The name of the bucket to put the file in. */ bucket: pulumi.Input; /** * Specifies caching behavior along the request/reply chain Read [w3c cacheControl](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9) for further details. */ cacheControl?: pulumi.Input; /** * Literal string value to use as the object content, which will be uploaded as UTF-8-encoded text. */ content?: pulumi.Input; /** * 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. */ contentBase64?: pulumi.Input; /** * Specifies presentational information for the object. Read [w3c contentDisposition](http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1) for further information. */ contentDisposition?: pulumi.Input; /** * 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](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11) for further information. */ contentEncoding?: pulumi.Input; /** * The language the content is in e.g. en-US or en-GB. */ contentLanguage?: pulumi.Input; /** * 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. */ contentType?: pulumi.Input; /** * Used to trigger updates. */ etag?: pulumi.Input; /** * Allow the object to be deleted by removing any legal hold on any object version. * Default is `false`. This value should be set to `true` only if the bucket has S3 object lock enabled. * * If no content is provided through `source`, `content` or `contentBase64`, then the object will be empty. * * > **Note:** The provider ignores all leading `/`s in the object's `key` and treats multiple `/`s in the rest of the object's `key` as a single `/`, so values of `/index.html` and `index.html` correspond to the same S3 object as do `first//second///third//` and `first/second/third/`. */ forceDestroy?: pulumi.Input; /** * The name of the object once it is in the bucket. */ key: pulumi.Input; /** * A mapping of keys/values to provision metadata (will be automatically prefixed by `x-amz-meta-`, note that only lowercase label are currently supported by the AWS Go API). */ metadata?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * The region where the bucket resides (Defaults to `nyc3`) */ region: pulumi.Input; /** * The path to a file that will be read and uploaded as raw bytes for the object content. */ source?: pulumi.Input; /** * Specifies a target URL for [website redirect](http://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html). */ websiteRedirect?: pulumi.Input; }