@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
313 lines • 12.8 kB
JavaScript
;
// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.IAMBinding = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* When managing IAM roles, you can treat a service account either as a resource or as an identity. This resource is to add iam policy bindings to a service account resource, such as allowing the members to run operations as or modify the service account. To configure permissions for a service account on other GCP resources, use the googleProjectIam set of resources.
*
* Three different resources help you manage your IAM policy for a service account. Each of these resources serves a different use case:
*
* * `gcp.serviceaccount.IAMPolicy`: Authoritative. Sets the IAM policy for the service account and replaces any existing policy already attached.
* * `gcp.serviceaccount.IAMBinding`: 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 service account are preserved.
* * `gcp.serviceaccount.IAMMember`: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the service account are preserved.
*
* > **Note:** `gcp.serviceaccount.IAMPolicy` **cannot** be used in conjunction with `gcp.serviceaccount.IAMBinding` and `gcp.serviceaccount.IAMMember` or they will fight over what your policy should be.
*
* > **Note:** `gcp.serviceaccount.IAMBinding` resources **can be** used in conjunction with `gcp.serviceaccount.IAMMember` resources **only if** they do not grant privilege to the same role.
*
* ## Example Usage
*
* ### Service Account IAM Policy
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const admin = gcp.organizations.getIAMPolicy({
* bindings: [{
* role: "roles/iam.serviceAccountUser",
* members: ["user:jane@example.com"],
* }],
* });
* const sa = new gcp.serviceaccount.Account("sa", {
* accountId: "my-service-account",
* displayName: "A service account that only Jane can interact with",
* });
* const admin_account_iam = new gcp.serviceaccount.IAMPolicy("admin-account-iam", {
* serviceAccountId: sa.name,
* policyData: admin.then(admin => admin.policyData),
* });
* ```
*
* ### Service Account IAM Binding
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const sa = new gcp.serviceaccount.Account("sa", {
* accountId: "my-service-account",
* displayName: "A service account that only Jane can use",
* });
* const admin_account_iam = new gcp.serviceaccount.IAMBinding("admin-account-iam", {
* serviceAccountId: sa.name,
* role: "roles/iam.serviceAccountUser",
* members: ["user:jane@example.com"],
* });
* ```
*
* ### Service Account IAM Binding With IAM Conditions:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const sa = new gcp.serviceaccount.Account("sa", {
* accountId: "my-service-account",
* displayName: "A service account that only Jane can use",
* });
* const admin_account_iam = new gcp.serviceaccount.IAMBinding("admin-account-iam", {
* serviceAccountId: sa.name,
* role: "roles/iam.serviceAccountUser",
* 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\")",
* },
* });
* ```
*
* ### Service Account IAM Member
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const _default = gcp.compute.getDefaultServiceAccount({});
* const sa = new gcp.serviceaccount.Account("sa", {
* accountId: "my-service-account",
* displayName: "A service account that Jane can use",
* });
* const admin_account_iam = new gcp.serviceaccount.IAMMember("admin-account-iam", {
* serviceAccountId: sa.name,
* role: "roles/iam.serviceAccountUser",
* member: "user:jane@example.com",
* });
* // Allow SA service account use the default GCE account
* const gce_default_account_iam = new gcp.serviceaccount.IAMMember("gce-default-account-iam", {
* serviceAccountId: _default.then(_default => _default.name),
* role: "roles/iam.serviceAccountUser",
* member: pulumi.interpolate`serviceAccount:${sa.email}`,
* });
* ```
*
* ### Service Account IAM Member With IAM Conditions:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const sa = new gcp.serviceaccount.Account("sa", {
* accountId: "my-service-account",
* displayName: "A service account that Jane can use",
* });
* const admin_account_iam = new gcp.serviceaccount.IAMMember("admin-account-iam", {
* serviceAccountId: sa.name,
* role: "roles/iam.serviceAccountUser",
* 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\")",
* },
* });
* ```
*
* ### Additional Examples
*
* ### Service Account IAM Policy
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const admin = gcp.organizations.getIAMPolicy({
* bindings: [{
* role: "roles/iam.serviceAccountUser",
* members: ["user:jane@example.com"],
* }],
* });
* const sa = new gcp.serviceaccount.Account("sa", {
* accountId: "my-service-account",
* displayName: "A service account that only Jane can interact with",
* });
* const admin_account_iam = new gcp.serviceaccount.IAMPolicy("admin-account-iam", {
* serviceAccountId: sa.name,
* policyData: admin.then(admin => admin.policyData),
* });
* ```
*
* ### Service Account IAM Binding
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const sa = new gcp.serviceaccount.Account("sa", {
* accountId: "my-service-account",
* displayName: "A service account that only Jane can use",
* });
* const admin_account_iam = new gcp.serviceaccount.IAMBinding("admin-account-iam", {
* serviceAccountId: sa.name,
* role: "roles/iam.serviceAccountUser",
* members: ["user:jane@example.com"],
* });
* ```
*
* ### Service Account IAM Binding With IAM Conditions:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const sa = new gcp.serviceaccount.Account("sa", {
* accountId: "my-service-account",
* displayName: "A service account that only Jane can use",
* });
* const admin_account_iam = new gcp.serviceaccount.IAMBinding("admin-account-iam", {
* serviceAccountId: sa.name,
* role: "roles/iam.serviceAccountUser",
* 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\")",
* },
* });
* ```
*
* ### Service Account IAM Member
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const _default = gcp.compute.getDefaultServiceAccount({});
* const sa = new gcp.serviceaccount.Account("sa", {
* accountId: "my-service-account",
* displayName: "A service account that Jane can use",
* });
* const admin_account_iam = new gcp.serviceaccount.IAMMember("admin-account-iam", {
* serviceAccountId: sa.name,
* role: "roles/iam.serviceAccountUser",
* member: "user:jane@example.com",
* });
* // Allow SA service account use the default GCE account
* const gce_default_account_iam = new gcp.serviceaccount.IAMMember("gce-default-account-iam", {
* serviceAccountId: _default.then(_default => _default.name),
* role: "roles/iam.serviceAccountUser",
* member: pulumi.interpolate`serviceAccount:${sa.email}`,
* });
* ```
*
* ### Service Account IAM Member With IAM Conditions:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const sa = new gcp.serviceaccount.Account("sa", {
* accountId: "my-service-account",
* displayName: "A service account that Jane can use",
* });
* const admin_account_iam = new gcp.serviceaccount.IAMMember("admin-account-iam", {
* serviceAccountId: sa.name,
* role: "roles/iam.serviceAccountUser",
* 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 with conditions:
*
* Here are examples of importing IAM memberships and bindings that include conditions:
*
* ```sh
* $ pulumi import gcp:serviceaccount/iAMBinding:IAMBinding admin-account-iam "projects/{your-project-id}/serviceAccounts/{your-service-account-email} roles/iam.serviceAccountUser expires_after_2019_12_31"
* ```
*
* ```sh
* $ pulumi import gcp:serviceaccount/iAMBinding:IAMBinding admin-account-iam "projects/{your-project-id}/serviceAccounts/{your-service-account-email} roles/iam.serviceAccountUser user:foo@example.com expires_after_2019_12_31"
* ```
*/
class IAMBinding extends pulumi.CustomResource {
/**
* Get an existing IAMBinding 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 IAMBinding(name, state, Object.assign(Object.assign({}, opts), { id: id }));
}
/**
* Returns true if the given object is an instance of IAMBinding. 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'] === IAMBinding.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["condition"] = state ? state.condition : undefined;
resourceInputs["etag"] = state ? state.etag : undefined;
resourceInputs["members"] = state ? state.members : undefined;
resourceInputs["role"] = state ? state.role : undefined;
resourceInputs["serviceAccountId"] = state ? state.serviceAccountId : undefined;
}
else {
const args = argsOrState;
if ((!args || args.members === undefined) && !opts.urn) {
throw new Error("Missing required property 'members'");
}
if ((!args || args.role === undefined) && !opts.urn) {
throw new Error("Missing required property 'role'");
}
if ((!args || args.serviceAccountId === undefined) && !opts.urn) {
throw new Error("Missing required property 'serviceAccountId'");
}
resourceInputs["condition"] = args ? args.condition : undefined;
resourceInputs["members"] = args ? args.members : undefined;
resourceInputs["role"] = args ? args.role : undefined;
resourceInputs["serviceAccountId"] = args ? args.serviceAccountId : undefined;
resourceInputs["etag"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
const aliasOpts = { aliases: [{ type: "gcp:serviceAccount/iAMBinding:IAMBinding" }] };
opts = pulumi.mergeOptions(opts, aliasOpts);
super(IAMBinding.__pulumiType, name, resourceInputs, opts);
}
}
exports.IAMBinding = IAMBinding;
/** @internal */
IAMBinding.__pulumiType = 'gcp:serviceaccount/iAMBinding:IAMBinding';
//# sourceMappingURL=iambinding.js.map