IAM policy for Google Cloud KMS key ring

Three different resources help you manage your IAM policy for KMS key ring. Each of these resources serves a different use case:

googleKmsKeyRingIamPolicy: Authoritative. Sets the IAM policy for the key ring and replaces any existing policy already attached.
googleKmsKeyRingIamBinding: 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.
googleKmsKeyRingIamMember: 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: googleKmsKeyRingIamPolicy cannot be used in conjunction with googleKmsKeyRingIamBinding and googleKmsKeyRingIamMember or they will fight over what your policy should be.

\~> Note: googleKmsKeyRingIamBinding resources can be used in conjunction with googleKmsKeyRingIamMember resources only if they do not grant privilege to the same role.

googleKmsKeyRingIamPolicy

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as google from "./.gen/providers/google";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: google.
For a more precise conversion please use the --provider flag in convert.*/
const googleKmsKeyRingKeyring = new google.kmsKeyRing.KmsKeyRing(
  this,
  "keyring",
  {
    location: "global",
    name: "keyring-example",
  }
);
const dataGoogleIamPolicyAdmin =
  new google.dataGoogleIamPolicy.DataGoogleIamPolicy(this, "admin", {
    binding: [
      {
        members: ["user:jane@example.com"],
        role: "roles/editor",
      },
    ],
  });
new google.kmsKeyRingIamPolicy.KmsKeyRingIamPolicy(this, "key_ring", {
  key_ring_id: googleKmsKeyRingKeyring.id,
  policy_data: dataGoogleIamPolicyAdmin.policyData,
});

With IAM Conditions (beta):

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as google from "./.gen/providers/google";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: google.
For a more precise conversion please use the --provider flag in convert.*/
const googleKmsKeyRingKeyring = new google.kmsKeyRing.KmsKeyRing(
  this,
  "keyring",
  {
    location: "global",
    name: "keyring-example",
  }
);
const dataGoogleIamPolicyAdmin =
  new google.dataGoogleIamPolicy.DataGoogleIamPolicy(this, "admin", {
    binding: [
      {
        condition: [
          {
            description: "Expiring at midnight of 2019-12-31",
            expression: 'request.time < timestamp("2020-01-01T00:00:00Z")',
            title: "expires_after_2019_12_31",
          },
        ],
        members: ["user:jane@example.com"],
        role: "roles/editor",
      },
    ],
  });
new google.kmsKeyRingIamPolicy.KmsKeyRingIamPolicy(this, "key_ring", {
  key_ring_id: googleKmsKeyRingKeyring.id,
  policy_data: dataGoogleIamPolicyAdmin.policyData,
});

googleKmsKeyRingIamBinding

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as google from "./.gen/providers/google";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: google.
For a more precise conversion please use the --provider flag in convert.*/
new google.kmsKeyRingIamBinding.KmsKeyRingIamBinding(this, "key_ring", {
  key_ring_id: "your-key-ring-id",
  members: ["user:jane@example.com"],
  role: "roles/cloudkms.admin",
});

With IAM Conditions (beta):

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as google from "./.gen/providers/google";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: google.
For a more precise conversion please use the --provider flag in convert.*/
new google.kmsKeyRingIamBinding.KmsKeyRingIamBinding(this, "key_ring", {
  condition: [
    {
      description: "Expiring at midnight of 2019-12-31",
      expression: 'request.time < timestamp("2020-01-01T00:00:00Z")',
      title: "expires_after_2019_12_31",
    },
  ],
  key_ring_id: "your-key-ring-id",
  members: ["user:jane@example.com"],
  role: "roles/cloudkms.admin",
});

googleKmsKeyRingIamMember

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as google from "./.gen/providers/google";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: google.
For a more precise conversion please use the --provider flag in convert.*/
new google.kmsKeyRingIamMember.KmsKeyRingIamMember(this, "key_ring", {
  key_ring_id: "your-key-ring-id",
  member: "user:jane@example.com",
  role: "roles/cloudkms.admin",
});

With IAM Conditions (beta):

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as google from "./.gen/providers/google";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: google.
For a more precise conversion please use the --provider flag in convert.*/
new google.kmsKeyRingIamMember.KmsKeyRingIamMember(this, "key_ring", {
  condition: [
    {
      description: "Expiring at midnight of 2019-12-31",
      expression: 'request.time < timestamp("2020-01-01T00:00:00Z")',
      title: "expires_after_2019_12_31",
    },
  ],
  key_ring_id: "your-key-ring-id",
  member: "user:jane@example.com",
  role: "roles/cloudkms.admin",
});

Argument Reference

The following arguments are supported:

keyRingId - (Required) The key ring ID, in the form {projectId}/{locationName}/{keyRingName} or {locationName}/{keyRingName}. In the second form, the provider's project setting will be used as a fallback.
member/members - (Required) Identities that will be granted the privilege in role. Each entry can have one of the following values:
- allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
- allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
- user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
- serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
- group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
- domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
role - (Required) The role that should be applied. Only one googleKmsKeyRingIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parentName}/roles/{roleName}.
policyData - (Required only by googleKmsKeyRingIamPolicy) The policy data generated by a googleIamPolicy data source.
condition - (Optional, Beta) An IAM Condition for a given binding. Structure is documented below.

The condition block supports:

expression - (Required) Textual representation of an expression in Common Expression Language syntax.
title - (Required) A title for the expression, i.e. a short string describing its purpose.
description - (Optional) An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

\~> Warning: Terraform considers the role and condition contents (title+description+expression) as the identifier for the binding. This means that if any part of the condition is changed out-of-band, Terraform will consider it to be an entirely different resource and will treat it as such.

Attributes Reference

In addition to the arguments listed above, the following computed attributes are exported:

etag - (Computed) The etag of the key ring's IAM policy.

Import

IAM member imports use space-delimited identifiers; the resource in question, the role, and the account. This member resource can be imported using the keyRingId, role, and account e.g.

$ terraform import google_kms_key_ring_iam_member.key_ring_iam "your-project-id/location-name/key-ring-name roles/viewer user:foo@example.com"

IAM binding imports use space-delimited identifiers; the resource in question and the role. This binding resource can be imported using the keyRingId and role, e.g.

$ terraform import google_kms_key_ring_iam_binding.key_ring_iam "your-project-id/location-name/key-ring-name roles/cloudkms.admin"

IAM policy imports use the identifier of the resource in question. This policy resource can be imported using the keyRingId, e.g.

$ terraform import google_kms_key_ring_iam_policy.key_ring_iam your-project-id/location-name/key-ring-name