@pulumi/digitalocean
Version:
A Pulumi package for creating and managing DigitalOcean cloud resources.
138 lines • 5.41 kB
JavaScript
;
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.SpacesKey = void 0;
const pulumi = __importStar(require("@pulumi/pulumi"));
const utilities = __importStar(require("./utilities"));
/**
* Provides a key resource for Spaces, DigitalOcean's object storage product.
*
* 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.
*
* As a Spaces owner, you limit others’ access to your buckets using Spaces access
* keys. Access keys can provide several levels of permissions to create, destroy,
* read, and write to specific associated buckets. However, access keys only limit
* access to certain commands using the S3 API or CLI, not the control panel or
* other DigitalOcean resources.
*
* ## Example Usage
*
* ### Create a New Key
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as digitalocean from "@pulumi/digitalocean";
*
* const foobar = new digitalocean.SpacesKey("foobar", {name: "foobar"});
* ```
*
* ### Create a New Key with Grants
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as digitalocean from "@pulumi/digitalocean";
*
* const foobar = new digitalocean.SpacesKey("foobar", {
* name: "foobar",
* grants: [{
* bucket: "my-bucket",
* permission: "read",
* }],
* });
* ```
*
* ### Create a New Key with full access
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as digitalocean from "@pulumi/digitalocean";
*
* const foobar = new digitalocean.SpacesKey("foobar", {
* name: "foobar",
* grants: [{
* bucket: "",
* permission: "fullaccess",
* }],
* });
* ```
*/
class SpacesKey extends pulumi.CustomResource {
/**
* Get an existing SpacesKey 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, id, state, opts) {
return new SpacesKey(name, state, { ...opts, id: id });
}
/** @internal */
static __pulumiType = 'digitalocean:index/spacesKey:SpacesKey';
/**
* Returns true if the given object is an instance of SpacesKey. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === SpacesKey.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["accessKey"] = state?.accessKey;
resourceInputs["createdAt"] = state?.createdAt;
resourceInputs["grants"] = state?.grants;
resourceInputs["name"] = state?.name;
resourceInputs["secretKey"] = state?.secretKey;
}
else {
const args = argsOrState;
resourceInputs["grants"] = args?.grants;
resourceInputs["name"] = args?.name;
resourceInputs["accessKey"] = undefined /*out*/;
resourceInputs["createdAt"] = undefined /*out*/;
resourceInputs["secretKey"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
const secretOpts = { additionalSecretOutputs: ["secretKey"] };
opts = pulumi.mergeOptions(opts, secretOpts);
super(SpacesKey.__pulumiType, name, resourceInputs, opts);
}
}
exports.SpacesKey = SpacesKey;
//# sourceMappingURL=spacesKey.js.map