@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
125 lines • 4.34 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.getKeyOutput = exports.getKey = void 0;
const pulumi = __importStar(require("@pulumi/pulumi"));
const utilities = __importStar(require("../utilities"));
/**
* Gets information about a Key Manager Key. For more information, refer to the [Key Manager API documentation](https://www.scaleway.com/en/developers/api/key-manager/#path-keys-get-key-metadata).
*
* ## Example Usage
*
* ### Create a key and get its information
*
* The following commands allow you to:
*
* - create a key named `my-kms-key`
* - retrieve the key's information using the key's ID
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* // Create a key
* const symmetric = new scaleway.keymanager.Key("symmetric", {
* name: "my-kms-key",
* region: "fr-par",
* projectId: "your-project-id",
* usage: "symmetric_encryption",
* algorithm: "aes_256_gcm",
* description: "Key for encrypting secrets",
* tags: [
* "env:prod",
* "kms",
* ],
* unprotected: true,
* rotationPolicy: {
* rotationPeriod: "720h",
* },
* });
* // Get the key information by its ID
* const byID = scaleway.keymanager.getKey({
* keyId: "11111111-1111-1111-1111-111111111111",
* });
* ```
*/
function getKey(args, opts) {
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
return pulumi.runtime.invoke("scaleway:keymanager/getKey:getKey", {
"keyId": args.keyId,
"region": args.region,
}, opts);
}
exports.getKey = getKey;
/**
* Gets information about a Key Manager Key. For more information, refer to the [Key Manager API documentation](https://www.scaleway.com/en/developers/api/key-manager/#path-keys-get-key-metadata).
*
* ## Example Usage
*
* ### Create a key and get its information
*
* The following commands allow you to:
*
* - create a key named `my-kms-key`
* - retrieve the key's information using the key's ID
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* // Create a key
* const symmetric = new scaleway.keymanager.Key("symmetric", {
* name: "my-kms-key",
* region: "fr-par",
* projectId: "your-project-id",
* usage: "symmetric_encryption",
* algorithm: "aes_256_gcm",
* description: "Key for encrypting secrets",
* tags: [
* "env:prod",
* "kms",
* ],
* unprotected: true,
* rotationPolicy: {
* rotationPeriod: "720h",
* },
* });
* // Get the key information by its ID
* const byID = scaleway.keymanager.getKey({
* keyId: "11111111-1111-1111-1111-111111111111",
* });
* ```
*/
function getKeyOutput(args, opts) {
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
return pulumi.runtime.invokeOutput("scaleway:keymanager/getKey:getKey", {
"keyId": args.keyId,
"region": args.region,
}, opts);
}
exports.getKeyOutput = getKeyOutput;
//# sourceMappingURL=getKey.js.map