@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
166 lines • 6.62 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.GroupMembership = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* A Membership defines a relationship between a Group and an entity belonging to that Group, referred to as a "member".
*
* To get more information about GroupMembership, see:
*
* * [API documentation](https://cloud.google.com/identity/docs/reference/rest/v1/groups.memberships)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/identity/docs/how-to/memberships-google-groups)
*
* > **Warning:** If you are using User ADCs (Application Default Credentials) with this resource,
* you must specify a `billingProject` and set `userProjectOverride` to true
* in the provider configuration. Otherwise the Cloud Identity API will return a 403 error.
* Your account must have the `serviceusage.services.use` permission on the
* `billingProject` you defined.
*
* ## Example Usage
*
* ### Cloud Identity Group Membership
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const group = new gcp.cloudidentity.Group("group", {
* displayName: "my-identity-group",
* parent: "customers/A01b123xz",
* groupKey: {
* id: "my-identity-group@example.com",
* },
* labels: {
* "cloudidentity.googleapis.com/groups.discussion_forum": "",
* },
* });
* const child_group = new gcp.cloudidentity.Group("child-group", {
* displayName: "my-identity-group-child",
* parent: "customers/A01b123xz",
* groupKey: {
* id: "my-identity-group-child@example.com",
* },
* labels: {
* "cloudidentity.googleapis.com/groups.discussion_forum": "",
* },
* });
* const cloudIdentityGroupMembershipBasic = new gcp.cloudidentity.GroupMembership("cloud_identity_group_membership_basic", {
* group: group.id,
* preferredMemberKey: {
* id: child_group.groupKey.apply(groupKey => groupKey.id),
* },
* roles: [{
* name: "MEMBER",
* }],
* });
* ```
* ### Cloud Identity Group Membership User
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const group = new gcp.cloudidentity.Group("group", {
* displayName: "my-identity-group",
* parent: "customers/A01b123xz",
* groupKey: {
* id: "my-identity-group@example.com",
* },
* labels: {
* "cloudidentity.googleapis.com/groups.discussion_forum": "",
* },
* });
* const cloudIdentityGroupMembershipBasic = new gcp.cloudidentity.GroupMembership("cloud_identity_group_membership_basic", {
* group: group.id,
* preferredMemberKey: {
* id: "cloud_identity_user@example.com",
* },
* roles: [
* {
* name: "MEMBER",
* },
* {
* name: "MANAGER",
* },
* ],
* });
* ```
*
* ## Import
*
* GroupMembership can be imported using any of these accepted formats:
*
* * `{{name}}`
*
* When using the `pulumi import` command, GroupMembership can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:cloudidentity/groupMembership:GroupMembership default {{name}}
* ```
*/
class GroupMembership extends pulumi.CustomResource {
/**
* Get an existing GroupMembership 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 GroupMembership(name, state, Object.assign(Object.assign({}, opts), { id: id }));
}
/**
* Returns true if the given object is an instance of GroupMembership. 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'] === GroupMembership.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["createTime"] = state ? state.createTime : undefined;
resourceInputs["group"] = state ? state.group : undefined;
resourceInputs["memberKey"] = state ? state.memberKey : undefined;
resourceInputs["name"] = state ? state.name : undefined;
resourceInputs["preferredMemberKey"] = state ? state.preferredMemberKey : undefined;
resourceInputs["roles"] = state ? state.roles : undefined;
resourceInputs["type"] = state ? state.type : undefined;
resourceInputs["updateTime"] = state ? state.updateTime : undefined;
}
else {
const args = argsOrState;
if ((!args || args.group === undefined) && !opts.urn) {
throw new Error("Missing required property 'group'");
}
if ((!args || args.roles === undefined) && !opts.urn) {
throw new Error("Missing required property 'roles'");
}
resourceInputs["group"] = args ? args.group : undefined;
resourceInputs["memberKey"] = args ? args.memberKey : undefined;
resourceInputs["preferredMemberKey"] = args ? args.preferredMemberKey : undefined;
resourceInputs["roles"] = args ? args.roles : undefined;
resourceInputs["createTime"] = undefined /*out*/;
resourceInputs["name"] = undefined /*out*/;
resourceInputs["type"] = undefined /*out*/;
resourceInputs["updateTime"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(GroupMembership.__pulumiType, name, resourceInputs, opts);
}
}
exports.GroupMembership = GroupMembership;
/** @internal */
GroupMembership.__pulumiType = 'gcp:cloudidentity/groupMembership:GroupMembership';
//# sourceMappingURL=groupMembership.js.map