@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
269 lines • 9.15 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! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.KeyRingIAMPolicy = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* Three different resources help you manage your IAM policy for KMS key ring. Each of these resources serves a different use case:
*
* * `gcp.kms.KeyRingIAMPolicy`: Authoritative. Sets the IAM policy for the key ring and replaces any existing policy already attached.
* * `gcp.kms.KeyRingIAMBinding`: Authoritative for a given role. Updates the IAM policy to grant a role to a list of members. Other roles within the IAM policy for the key ring are preserved.
* * `gcp.kms.KeyRingIAMMember`: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the key ring are preserved.
*
* > **Note:** `gcp.kms.KeyRingIAMPolicy` **cannot** be used in conjunction with `gcp.kms.KeyRingIAMBinding` and `gcp.kms.KeyRingIAMMember` or they will fight over what your policy should be.
*
* > **Note:** `gcp.kms.KeyRingIAMBinding` resources **can be** used in conjunction with `gcp.kms.KeyRingIAMMember` resources **only if** they do not grant privilege to the same role.
*
* ## gcp.kms.KeyRingIAMPolicy
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const keyring = new gcp.kms.KeyRing("keyring", {
* name: "keyring-example",
* location: "global",
* });
* const admin = gcp.organizations.getIAMPolicy({
* bindings: [{
* role: "roles/editor",
* members: ["user:jane@example.com"],
* }],
* });
* const keyRing = new gcp.kms.KeyRingIAMPolicy("key_ring", {
* keyRingId: keyring.id,
* policyData: admin.then(admin => admin.policyData),
* });
* ```
*
* With IAM Conditions:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const keyring = new gcp.kms.KeyRing("keyring", {
* name: "keyring-example",
* location: "global",
* });
* const admin = gcp.organizations.getIAMPolicy({
* bindings: [{
* role: "roles/editor",
* members: ["user:jane@example.com"],
* condition: {
* title: "expires_after_2019_12_31",
* description: "Expiring at midnight of 2019-12-31",
* expression: "request.time < timestamp(\"2020-01-01T00:00:00Z\")",
* },
* }],
* });
* const keyRing = new gcp.kms.KeyRingIAMPolicy("key_ring", {
* keyRingId: keyring.id,
* policyData: admin.then(admin => admin.policyData),
* });
* ```
*
* ## gcp.kms.KeyRingIAMBinding
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const keyRing = new gcp.kms.KeyRingIAMBinding("key_ring", {
* keyRingId: "your-key-ring-id",
* role: "roles/cloudkms.admin",
* members: ["user:jane@example.com"],
* });
* ```
*
* With IAM Conditions:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const keyRing = new gcp.kms.KeyRingIAMBinding("key_ring", {
* keyRingId: "your-key-ring-id",
* role: "roles/cloudkms.admin",
* members: ["user:jane@example.com"],
* condition: {
* title: "expires_after_2019_12_31",
* description: "Expiring at midnight of 2019-12-31",
* expression: "request.time < timestamp(\"2020-01-01T00:00:00Z\")",
* },
* });
* ```
*
* ## gcp.kms.KeyRingIAMMember
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const keyRing = new gcp.kms.KeyRingIAMMember("key_ring", {
* keyRingId: "your-key-ring-id",
* role: "roles/cloudkms.admin",
* member: "user:jane@example.com",
* });
* ```
*
* With IAM Conditions:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const keyRing = new gcp.kms.KeyRingIAMMember("key_ring", {
* keyRingId: "your-key-ring-id",
* role: "roles/cloudkms.admin",
* member: "user:jane@example.com",
* condition: {
* title: "expires_after_2019_12_31",
* description: "Expiring at midnight of 2019-12-31",
* expression: "request.time < timestamp(\"2020-01-01T00:00:00Z\")",
* },
* });
* ```
*
* ## gcp.kms.KeyRingIAMBinding
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const keyRing = new gcp.kms.KeyRingIAMBinding("key_ring", {
* keyRingId: "your-key-ring-id",
* role: "roles/cloudkms.admin",
* members: ["user:jane@example.com"],
* });
* ```
*
* With IAM Conditions:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const keyRing = new gcp.kms.KeyRingIAMBinding("key_ring", {
* keyRingId: "your-key-ring-id",
* role: "roles/cloudkms.admin",
* members: ["user:jane@example.com"],
* condition: {
* title: "expires_after_2019_12_31",
* description: "Expiring at midnight of 2019-12-31",
* expression: "request.time < timestamp(\"2020-01-01T00:00:00Z\")",
* },
* });
* ```
*
* ## gcp.kms.KeyRingIAMMember
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const keyRing = new gcp.kms.KeyRingIAMMember("key_ring", {
* keyRingId: "your-key-ring-id",
* role: "roles/cloudkms.admin",
* member: "user:jane@example.com",
* });
* ```
*
* With IAM Conditions:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const keyRing = new gcp.kms.KeyRingIAMMember("key_ring", {
* keyRingId: "your-key-ring-id",
* role: "roles/cloudkms.admin",
* member: "user:jane@example.com",
* condition: {
* title: "expires_after_2019_12_31",
* description: "Expiring at midnight of 2019-12-31",
* expression: "request.time < timestamp(\"2020-01-01T00:00:00Z\")",
* },
* });
* ```
*
* ## Import
*
* ### Importing IAM policies
*
* IAM policy imports use the identifier of the Cloud KMS key ring only. For example:
*
* * `{{project_id}}/{{location}}/{{key_ring_name}}`
*
* An `import` block (Terraform v1.5.0 and later) can be used to import IAM policies:
*
* tf
*
* import {
*
* id = "{{project_id}}/{{location}}/{{key_ring_name}}"
*
* to = google_kms_key_ring_iam_policy.default
*
* }
*
* The `pulumi import` command can also be used:
*
* ```sh
* $ pulumi import gcp:kms/keyRingIAMPolicy:KeyRingIAMPolicy default {{project_id}}/{{location}}/{{key_ring_name}}
* ```
*/
class KeyRingIAMPolicy extends pulumi.CustomResource {
/**
* Get an existing KeyRingIAMPolicy 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 KeyRingIAMPolicy(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of KeyRingIAMPolicy. 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'] === KeyRingIAMPolicy.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["etag"] = state?.etag;
resourceInputs["keyRingId"] = state?.keyRingId;
resourceInputs["policyData"] = state?.policyData;
}
else {
const args = argsOrState;
if (args?.keyRingId === undefined && !opts.urn) {
throw new Error("Missing required property 'keyRingId'");
}
if (args?.policyData === undefined && !opts.urn) {
throw new Error("Missing required property 'policyData'");
}
resourceInputs["keyRingId"] = args?.keyRingId;
resourceInputs["policyData"] = args?.policyData;
resourceInputs["etag"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(KeyRingIAMPolicy.__pulumiType, name, resourceInputs, opts);
}
}
exports.KeyRingIAMPolicy = KeyRingIAMPolicy;
/** @internal */
KeyRingIAMPolicy.__pulumiType = 'gcp:kms/keyRingIAMPolicy:KeyRingIAMPolicy';
//# sourceMappingURL=keyRingIAMPolicy.js.map