The gcp:kms/ekmConnectionIamBinding:EkmConnectionIamBinding resource, part of the Pulumi GCP provider, manages IAM role bindings for Cloud KMS External Key Manager (EKM) connections, controlling which identities can access externally managed encryption keys. This guide focuses on three capabilities: granting roles to multiple members, adding individual members to roles, and time-based access with IAM conditions.
IAM bindings reference existing EKM connections and require a configured GCP project and location. The examples are intentionally small. Combine them with your own EKM connection resources and identity management.
Grant a role to multiple members with binding
When managing access to external key managers, you often need to grant the same role to multiple users or service accounts at once.
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const binding = new gcp.kms.EkmConnectionIamBinding("binding", {
project: example_ekmconnection.project,
location: example_ekmconnection.location,
name: example_ekmconnection.name,
role: "roles/viewer",
members: ["user:jane@example.com"],
});
import pulumi
import pulumi_gcp as gcp
binding = gcp.kms.EkmConnectionIamBinding("binding",
project=example_ekmconnection["project"],
location=example_ekmconnection["location"],
name=example_ekmconnection["name"],
role="roles/viewer",
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.NewEkmConnectionIamBinding(ctx, "binding", &kms.EkmConnectionIamBindingArgs{
Project: pulumi.Any(example_ekmconnection.Project),
Location: pulumi.Any(example_ekmconnection.Location),
Name: pulumi.Any(example_ekmconnection.Name),
Role: pulumi.String("roles/viewer"),
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 binding = new Gcp.Kms.EkmConnectionIamBinding("binding", new()
{
Project = example_ekmconnection.Project,
Location = example_ekmconnection.Location,
Name = example_ekmconnection.Name,
Role = "roles/viewer",
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.EkmConnectionIamBinding;
import com.pulumi.gcp.kms.EkmConnectionIamBindingArgs;
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 binding = new EkmConnectionIamBinding("binding", EkmConnectionIamBindingArgs.builder()
.project(example_ekmconnection.project())
.location(example_ekmconnection.location())
.name(example_ekmconnection.name())
.role("roles/viewer")
.members("user:jane@example.com")
.build());
}
}
resources:
binding:
type: gcp:kms:EkmConnectionIamBinding
properties:
project: ${["example-ekmconnection"].project}
location: ${["example-ekmconnection"].location}
name: ${["example-ekmconnection"].name}
role: roles/viewer
members:
- user:jane@example.com
The binding resource is authoritative for the specified role: it replaces all members for that role on the EKM connection. The members array accepts user accounts, service accounts, groups, and special identifiers like allAuthenticatedUsers. The project, location, and name properties identify which EKM connection receives the binding.
Add time-based access with IAM conditions
Temporary access grants expire automatically when conditions evaluate to false, eliminating manual cleanup for contractors or time-limited projects.
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const binding = new gcp.kms.EkmConnectionIamBinding("binding", {
project: example_ekmconnection.project,
location: example_ekmconnection.location,
name: example_ekmconnection.name,
role: "roles/viewer",
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
binding = gcp.kms.EkmConnectionIamBinding("binding",
project=example_ekmconnection["project"],
location=example_ekmconnection["location"],
name=example_ekmconnection["name"],
role="roles/viewer",
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/kms"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := kms.NewEkmConnectionIamBinding(ctx, "binding", &kms.EkmConnectionIamBindingArgs{
Project: pulumi.Any(example_ekmconnection.Project),
Location: pulumi.Any(example_ekmconnection.Location),
Name: pulumi.Any(example_ekmconnection.Name),
Role: pulumi.String("roles/viewer"),
Members: pulumi.StringArray{
pulumi.String("user:jane@example.com"),
},
Condition: &kms.EkmConnectionIamBindingConditionArgs{
Title: pulumi.String("expires_after_2019_12_31"),
Description: pulumi.String("Expiring at midnight of 2019-12-31"),
Expression: pulumi.String("request.time < timestamp(\"2020-01-01T00:00:00Z\")"),
},
})
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 binding = new Gcp.Kms.EkmConnectionIamBinding("binding", new()
{
Project = example_ekmconnection.Project,
Location = example_ekmconnection.Location,
Name = example_ekmconnection.Name,
Role = "roles/viewer",
Members = new[]
{
"user:jane@example.com",
},
Condition = new Gcp.Kms.Inputs.EkmConnectionIamBindingConditionArgs
{
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.kms.EkmConnectionIamBinding;
import com.pulumi.gcp.kms.EkmConnectionIamBindingArgs;
import com.pulumi.gcp.kms.inputs.EkmConnectionIamBindingConditionArgs;
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 binding = new EkmConnectionIamBinding("binding", EkmConnectionIamBindingArgs.builder()
.project(example_ekmconnection.project())
.location(example_ekmconnection.location())
.name(example_ekmconnection.name())
.role("roles/viewer")
.members("user:jane@example.com")
.condition(EkmConnectionIamBindingConditionArgs.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());
}
}
resources:
binding:
type: gcp:kms:EkmConnectionIamBinding
properties:
project: ${["example-ekmconnection"].project}
location: ${["example-ekmconnection"].location}
name: ${["example-ekmconnection"].name}
role: roles/viewer
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")
The condition block adds temporal constraints to role grants. The expression uses CEL (Common Expression Language) to compare request.time against a timestamp. When the condition evaluates to false, the binding no longer grants access. The title and description document the condition’s purpose for auditing.
Add a single member to an existing role
When you need to grant access to one additional user without affecting other members, the member resource adds to existing role assignments.
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const member = new gcp.kms.EkmConnectionIamMember("member", {
project: example_ekmconnection.project,
location: example_ekmconnection.location,
name: example_ekmconnection.name,
role: "roles/viewer",
member: "user:jane@example.com",
});
import pulumi
import pulumi_gcp as gcp
member = gcp.kms.EkmConnectionIamMember("member",
project=example_ekmconnection["project"],
location=example_ekmconnection["location"],
name=example_ekmconnection["name"],
role="roles/viewer",
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.NewEkmConnectionIamMember(ctx, "member", &kms.EkmConnectionIamMemberArgs{
Project: pulumi.Any(example_ekmconnection.Project),
Location: pulumi.Any(example_ekmconnection.Location),
Name: pulumi.Any(example_ekmconnection.Name),
Role: pulumi.String("roles/viewer"),
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 member = new Gcp.Kms.EkmConnectionIamMember("member", new()
{
Project = example_ekmconnection.Project,
Location = example_ekmconnection.Location,
Name = example_ekmconnection.Name,
Role = "roles/viewer",
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.EkmConnectionIamMember;
import com.pulumi.gcp.kms.EkmConnectionIamMemberArgs;
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 member = new EkmConnectionIamMember("member", EkmConnectionIamMemberArgs.builder()
.project(example_ekmconnection.project())
.location(example_ekmconnection.location())
.name(example_ekmconnection.name())
.role("roles/viewer")
.member("user:jane@example.com")
.build());
}
}
resources:
member:
type: gcp:kms:EkmConnectionIamMember
properties:
project: ${["example-ekmconnection"].project}
location: ${["example-ekmconnection"].location}
name: ${["example-ekmconnection"].name}
role: roles/viewer
member: user:jane@example.com
The member resource is non-authoritative: it adds one identity to a role without removing other members. Use member when you want to grant access incrementally. Use binding when you want to define all members for a role in one place.
Beyond these examples
These snippets focus on specific IAM binding features: role-based access control (binding and member resources) and time-based access with IAM conditions. They’re intentionally minimal rather than full access control policies.
The examples reference pre-existing infrastructure such as EKM connections (referenced but not created) and GCP project and location configuration. They focus on configuring access rather than provisioning the underlying key management infrastructure.
To keep things focused, common IAM patterns are omitted, including:
- Full policy replacement (EkmConnectionIamPolicy resource)
- Complex condition expressions (attribute-based, resource-based)
- Service account and group identity management
- Custom role definitions
These omissions are intentional: the goal is to illustrate how each IAM binding feature is wired, not provide drop-in access control modules. See the EkmConnectionIamBinding resource reference for all available configuration options.
Let's manage GCP Cloud KMS EKM Connection IAM Bindings
Get started with Pulumi Cloud, then follow our quick setup guide to deploy this infrastructure.
Try Pulumi Cloud for FREEFrequently Asked Questions
Resource Selection & Compatibility
gcp.kms.EkmConnectionIamPolicy is authoritative and replaces the entire IAM policy. gcp.kms.EkmConnectionIamBinding is authoritative for a specific role, managing all members for that role while preserving other roles. gcp.kms.EkmConnectionIamMember is non-authoritative, adding individual members without affecting other members for the same role.gcp.kms.EkmConnectionIamPolicy cannot be used with gcp.kms.EkmConnectionIamBinding or gcp.kms.EkmConnectionIamMember as they will conflict. However, gcp.kms.EkmConnectionIamBinding and gcp.kms.EkmConnectionIamMember can be used together only if they don’t grant the same role.Configuration & Identity Management
The members property supports multiple formats:
- allUsers / allAuthenticatedUsers for public/authenticated access
- user:{email}, serviceAccount:{email}, group:{email} for specific identities
- domain:{domain} for G Suite domains
- projectOwner/Editor/Viewer:{projectid} for project-level roles
- Federated identities using principal:// format for workload/workforce identity pools
[projects|organizations]/{parent-name}/roles/{role-name}. For example, projects/my-project/roles/my-custom-role or organizations/my-org/roles/my-custom-role.Advanced Features & Limitations
condition property with title, description, and expression fields. For example, to expire access at a specific time, set expression to request.time < timestamp("2020-01-01T00:00:00Z").