@pulumi/gcp/kms/getKMSKeyRing.js

A Pulumi package for creating and managing Google Cloud Platform resources.

"use strict";
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.getKMSKeyRingOutput = exports.getKMSKeyRing = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
 * Provides access to Google Cloud Platform KMS KeyRing. For more information see
 * [the official documentation](https://cloud.google.com/kms/docs/object-hierarchy#key_ring)
 * and
 * [API](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings).
 *
 * A KeyRing is a grouping of CryptoKeys for organizational purposes. A KeyRing belongs to a Google Cloud Platform Project
 * and resides in a specific location.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const myKeyRing = gcp.kms.getKMSKeyRing({
 *     name: "my-key-ring",
 *     location: "us-central1",
 * });
 * ```
 */
function getKMSKeyRing(args, opts) {
    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
    return pulumi.runtime.invoke("gcp:kms/getKMSKeyRing:getKMSKeyRing", {
        "location": args.location,
        "name": args.name,
        "project": args.project,
    }, opts);
}
exports.getKMSKeyRing = getKMSKeyRing;
/**
 * Provides access to Google Cloud Platform KMS KeyRing. For more information see
 * [the official documentation](https://cloud.google.com/kms/docs/object-hierarchy#key_ring)
 * and
 * [API](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings).
 *
 * A KeyRing is a grouping of CryptoKeys for organizational purposes. A KeyRing belongs to a Google Cloud Platform Project
 * and resides in a specific location.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const myKeyRing = gcp.kms.getKMSKeyRing({
 *     name: "my-key-ring",
 *     location: "us-central1",
 * });
 * ```
 */
function getKMSKeyRingOutput(args, opts) {
    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
    return pulumi.runtime.invokeOutput("gcp:kms/getKMSKeyRing:getKMSKeyRing", {
        "location": args.location,
        "name": args.name,
        "project": args.project,
    }, opts);
}
exports.getKMSKeyRingOutput = getKMSKeyRingOutput;
//# sourceMappingURL=getKMSKeyRing.js.map