The gcp:kms/cryptoKeyIAMPolicy:CryptoKeyIAMPolicy resource, part of the Pulumi GCP provider, manages IAM access policies for Cloud KMS crypto keys, controlling who can encrypt, decrypt, or manage keys. This guide focuses on four capabilities: authoritative policy replacement, role-level member binding, single-member grants, and time-based IAM Conditions.
IAM resources reference existing crypto keys. The CryptoKeyIAMPolicy resource replaces the entire policy and cannot be used alongside CryptoKeyIAMBinding or CryptoKeyIAMMember on the same key. The examples are intentionally small. Combine them with your own key infrastructure and member lists.
Set complete IAM policy for a crypto key
When you need to define the entire access policy in one place, replacing any existing permissions with a known-good configuration, use CryptoKeyIAMPolicy.
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 key = new gcp.kms.CryptoKey("key", {
name: "crypto-key-example",
keyRing: keyring.id,
rotationPeriod: "7776000s",
});
const admin = gcp.organizations.getIAMPolicy({
bindings: [{
role: "roles/cloudkms.cryptoKeyEncrypter",
members: ["user:jane@example.com"],
}],
});
const cryptoKey = new gcp.kms.CryptoKeyIAMPolicy("crypto_key", {
cryptoKeyId: key.id,
policyData: admin.then(admin => admin.policyData),
});
import pulumi
import pulumi_gcp as gcp
keyring = gcp.kms.KeyRing("keyring",
name="keyring-example",
location="global")
key = gcp.kms.CryptoKey("key",
name="crypto-key-example",
key_ring=keyring.id,
rotation_period="7776000s")
admin = gcp.organizations.get_iam_policy(bindings=[{
"role": "roles/cloudkms.cryptoKeyEncrypter",
"members": ["user:jane@example.com"],
}])
crypto_key = gcp.kms.CryptoKeyIAMPolicy("crypto_key",
crypto_key_id=key.id,
policy_data=admin.policy_data)
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/kms"
"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/organizations"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
keyring, err := kms.NewKeyRing(ctx, "keyring", &kms.KeyRingArgs{
Name: pulumi.String("keyring-example"),
Location: pulumi.String("global"),
})
if err != nil {
return err
}
key, err := kms.NewCryptoKey(ctx, "key", &kms.CryptoKeyArgs{
Name: pulumi.String("crypto-key-example"),
KeyRing: keyring.ID(),
RotationPeriod: pulumi.String("7776000s"),
})
if err != nil {
return err
}
admin, err := organizations.LookupIAMPolicy(ctx, &organizations.LookupIAMPolicyArgs{
Bindings: []organizations.GetIAMPolicyBinding{
{
Role: "roles/cloudkms.cryptoKeyEncrypter",
Members: []string{
"user:jane@example.com",
},
},
},
}, nil)
if err != nil {
return err
}
_, err = kms.NewCryptoKeyIAMPolicy(ctx, "crypto_key", &kms.CryptoKeyIAMPolicyArgs{
CryptoKeyId: key.ID(),
PolicyData: pulumi.String(admin.PolicyData),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var keyring = new Gcp.Kms.KeyRing("keyring", new()
{
Name = "keyring-example",
Location = "global",
});
var key = new Gcp.Kms.CryptoKey("key", new()
{
Name = "crypto-key-example",
KeyRing = keyring.Id,
RotationPeriod = "7776000s",
});
var admin = Gcp.Organizations.GetIAMPolicy.Invoke(new()
{
Bindings = new[]
{
new Gcp.Organizations.Inputs.GetIAMPolicyBindingInputArgs
{
Role = "roles/cloudkms.cryptoKeyEncrypter",
Members = new[]
{
"user:jane@example.com",
},
},
},
});
var cryptoKey = new Gcp.Kms.CryptoKeyIAMPolicy("crypto_key", new()
{
CryptoKeyId = key.Id,
PolicyData = admin.Apply(getIAMPolicyResult => getIAMPolicyResult.PolicyData),
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.kms.KeyRing;
import com.pulumi.gcp.kms.KeyRingArgs;
import com.pulumi.gcp.kms.CryptoKey;
import com.pulumi.gcp.kms.CryptoKeyArgs;
import com.pulumi.gcp.organizations.OrganizationsFunctions;
import com.pulumi.gcp.organizations.inputs.GetIAMPolicyArgs;
import com.pulumi.gcp.kms.CryptoKeyIAMPolicy;
import com.pulumi.gcp.kms.CryptoKeyIAMPolicyArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var keyring = new KeyRing("keyring", KeyRingArgs.builder()
.name("keyring-example")
.location("global")
.build());
var key = new CryptoKey("key", CryptoKeyArgs.builder()
.name("crypto-key-example")
.keyRing(keyring.id())
.rotationPeriod("7776000s")
.build());
final var admin = OrganizationsFunctions.getIAMPolicy(GetIAMPolicyArgs.builder()
.bindings(GetIAMPolicyBindingArgs.builder()
.role("roles/cloudkms.cryptoKeyEncrypter")
.members("user:jane@example.com")
.build())
.build());
var cryptoKey = new CryptoKeyIAMPolicy("cryptoKey", CryptoKeyIAMPolicyArgs.builder()
.cryptoKeyId(key.id())
.policyData(admin.policyData())
.build());
}
}
resources:
keyring:
type: gcp:kms:KeyRing
properties:
name: keyring-example
location: global
key:
type: gcp:kms:CryptoKey
properties:
name: crypto-key-example
keyRing: ${keyring.id}
rotationPeriod: 7776000s
cryptoKey:
type: gcp:kms:CryptoKeyIAMPolicy
name: crypto_key
properties:
cryptoKeyId: ${key.id}
policyData: ${admin.policyData}
variables:
admin:
fn::invoke:
function: gcp:organizations:getIAMPolicy
arguments:
bindings:
- role: roles/cloudkms.cryptoKeyEncrypter
members:
- user:jane@example.com
The policyData property accepts output from getIAMPolicy, which defines bindings between roles and members. CryptoKeyIAMPolicy replaces the entire policy on the crypto key, removing any grants not listed. The cryptoKeyId references the key to manage.
Add time-based conditions to policy bindings
Access policies sometimes need temporal constraints, granting permissions that expire automatically without manual revocation.
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const admin = gcp.organizations.getIAMPolicy({
bindings: [{
role: "roles/cloudkms.cryptoKeyEncrypter",
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\")",
},
}],
});
import pulumi
import pulumi_gcp as gcp
admin = gcp.organizations.get_iam_policy(bindings=[{
"role": "roles/cloudkms.cryptoKeyEncrypter",
"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\")",
},
}])
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/organizations"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := organizations.LookupIAMPolicy(ctx, &organizations.LookupIAMPolicyArgs{
Bindings: []organizations.GetIAMPolicyBinding{
{
Role: "roles/cloudkms.cryptoKeyEncrypter",
Members: []string{
"user:jane@example.com",
},
Condition: {
Title: "expires_after_2019_12_31",
Description: pulumi.StringRef("Expiring at midnight of 2019-12-31"),
Expression: "request.time < timestamp(\"2020-01-01T00:00:00Z\")",
},
},
},
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var admin = Gcp.Organizations.GetIAMPolicy.Invoke(new()
{
Bindings = new[]
{
new Gcp.Organizations.Inputs.GetIAMPolicyBindingInputArgs
{
Role = "roles/cloudkms.cryptoKeyEncrypter",
Members = new[]
{
"user:jane@example.com",
},
Condition = new Gcp.Organizations.Inputs.GetIAMPolicyBindingConditionInputArgs
{
Title = "expires_after_2019_12_31",
Description = "Expiring at midnight of 2019-12-31",
Expression = "request.time < timestamp(\"2020-01-01T00:00:00Z\")",
},
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.organizations.OrganizationsFunctions;
import com.pulumi.gcp.organizations.inputs.GetIAMPolicyArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var admin = OrganizationsFunctions.getIAMPolicy(GetIAMPolicyArgs.builder()
.bindings(GetIAMPolicyBindingArgs.builder()
.role("roles/cloudkms.cryptoKeyEncrypter")
.members("user:jane@example.com")
.condition(GetIAMPolicyBindingConditionArgs.builder()
.title("expires_after_2019_12_31")
.description("Expiring at midnight of 2019-12-31")
.expression("request.time < timestamp(\"2020-01-01T00:00:00Z\")")
.build())
.build())
.build());
}
}
variables:
admin:
fn::invoke:
function: gcp:organizations:getIAMPolicy
arguments:
bindings:
- role: roles/cloudkms.cryptoKeyEncrypter
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")
IAM Conditions add constraints to bindings through the condition block. The expression property uses CEL (Common Expression Language) to define when access is granted. Here, request.time checks the current timestamp against a deadline, automatically revoking access after 2019-12-31.
Grant a role to multiple members
When multiple users or service accounts need the same permission level, binding them to a single role avoids repetitive member-by-member grants.
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const cryptoKey = new gcp.kms.CryptoKeyIAMBinding("crypto_key", {
cryptoKeyId: key.id,
role: "roles/cloudkms.cryptoKeyEncrypter",
members: ["user:jane@example.com"],
});
import pulumi
import pulumi_gcp as gcp
crypto_key = gcp.kms.CryptoKeyIAMBinding("crypto_key",
crypto_key_id=key["id"],
role="roles/cloudkms.cryptoKeyEncrypter",
members=["user:jane@example.com"])
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/kms"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := kms.NewCryptoKeyIAMBinding(ctx, "crypto_key", &kms.CryptoKeyIAMBindingArgs{
CryptoKeyId: pulumi.Any(key.Id),
Role: pulumi.String("roles/cloudkms.cryptoKeyEncrypter"),
Members: pulumi.StringArray{
pulumi.String("user:jane@example.com"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var cryptoKey = new Gcp.Kms.CryptoKeyIAMBinding("crypto_key", new()
{
CryptoKeyId = key.Id,
Role = "roles/cloudkms.cryptoKeyEncrypter",
Members = new[]
{
"user:jane@example.com",
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.kms.CryptoKeyIAMBinding;
import com.pulumi.gcp.kms.CryptoKeyIAMBindingArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var cryptoKey = new CryptoKeyIAMBinding("cryptoKey", CryptoKeyIAMBindingArgs.builder()
.cryptoKeyId(key.id())
.role("roles/cloudkms.cryptoKeyEncrypter")
.members("user:jane@example.com")
.build());
}
}
resources:
cryptoKey:
type: gcp:kms:CryptoKeyIAMBinding
name: crypto_key
properties:
cryptoKeyId: ${key.id}
role: roles/cloudkms.cryptoKeyEncrypter
members:
- user:jane@example.com
CryptoKeyIAMBinding assigns one role to a list of members. The members array accepts user, serviceAccount, group, or domain identifiers. This resource is authoritative for the specified role: it replaces all members for that role but preserves other roles on the key.
Add a single member to a role
Adding one user or service account to a role without affecting other members requires non-authoritative updates.
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const cryptoKey = new gcp.kms.CryptoKeyIAMMember("crypto_key", {
cryptoKeyId: key.id,
role: "roles/cloudkms.cryptoKeyEncrypter",
member: "user:jane@example.com",
});
import pulumi
import pulumi_gcp as gcp
crypto_key = gcp.kms.CryptoKeyIAMMember("crypto_key",
crypto_key_id=key["id"],
role="roles/cloudkms.cryptoKeyEncrypter",
member="user:jane@example.com")
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/kms"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := kms.NewCryptoKeyIAMMember(ctx, "crypto_key", &kms.CryptoKeyIAMMemberArgs{
CryptoKeyId: pulumi.Any(key.Id),
Role: pulumi.String("roles/cloudkms.cryptoKeyEncrypter"),
Member: pulumi.String("user:jane@example.com"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var cryptoKey = new Gcp.Kms.CryptoKeyIAMMember("crypto_key", new()
{
CryptoKeyId = key.Id,
Role = "roles/cloudkms.cryptoKeyEncrypter",
Member = "user:jane@example.com",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.kms.CryptoKeyIAMMember;
import com.pulumi.gcp.kms.CryptoKeyIAMMemberArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var cryptoKey = new CryptoKeyIAMMember("cryptoKey", CryptoKeyIAMMemberArgs.builder()
.cryptoKeyId(key.id())
.role("roles/cloudkms.cryptoKeyEncrypter")
.member("user:jane@example.com")
.build());
}
}
resources:
cryptoKey:
type: gcp:kms:CryptoKeyIAMMember
name: crypto_key
properties:
cryptoKeyId: ${key.id}
role: roles/cloudkms.cryptoKeyEncrypter
member: user:jane@example.com
CryptoKeyIAMMember grants one role to one member without replacing existing grants. The member property accepts a single identity. This resource is non-authoritative: it adds the member without removing others. You can safely use CryptoKeyIAMMember alongside CryptoKeyIAMBinding as long as they manage different roles.
Beyond these examples
These snippets focus on specific IAM management features: authoritative vs non-authoritative IAM management and IAM Conditions for time-based access. They’re intentionally minimal rather than full access control systems.
The examples reference pre-existing infrastructure such as KMS KeyRing and CryptoKey resources. They focus on configuring IAM policies rather than provisioning the keys themselves.
To keep things focused, common IAM patterns are omitted, including:
- Condition expressions for resource attributes or request context
- Service account impersonation (serviceAccount:email format)
- Domain-wide grants (domain:example.com format)
- Multiple conditions per binding
These omissions are intentional: the goal is to illustrate how each IAM resource type is wired, not provide drop-in access control modules. See the CryptoKeyIAMPolicy resource reference for all available configuration options.
Let's manage GCP KMS Crypto Key IAM Policies
Get started with Pulumi Cloud, then follow our quick setup guide to deploy this infrastructure.
Try Pulumi Cloud for FREEFrequently Asked Questions
Resource Selection & Conflicts
Choose based on your needs:
CryptoKeyIAMPolicysets the entire IAM policy (authoritative, replaces existing policy)CryptoKeyIAMBindingmanages all members for a specific role (authoritative per role, preserves other roles)CryptoKeyIAMMemberadds individual members to a role (non-authoritative, preserves other members)
CryptoKeyIAMPolicy cannot be used with CryptoKeyIAMBinding or CryptoKeyIAMMember as they will conflict. However, you can use CryptoKeyIAMBinding and CryptoKeyIAMMember together if they manage different roles.Configuration & Usage
{project_id}/{location_name}/{key_ring_name}/{crypto_key_name} or {location_name}/{key_ring_name}/{crypto_key_name}. The shorter form uses your provider’s project setting as a fallback. Note that cryptoKeyId is immutable after creation.policyData using the gcp.organizations.getIAMPolicy data source, which takes bindings with roles and members.Advanced Features
title, description, and expression fields. For example, you can set expiration times using expressions like request.time < timestamp("2020-01-01T00:00:00Z").