@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
124 lines • 5.44 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.Group = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* A Cloud Identity resource representing a Group.
*
* To get more information about Group, see:
*
* * [API documentation](https://cloud.google.com/identity/docs/reference/rest/v1beta1/groups)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/identity/docs/how-to/setup)
*
* > **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 Groups Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const cloudIdentityGroupBasic = new gcp.cloudidentity.Group("cloud_identity_group_basic", {
* displayName: "my-identity-group",
* initialGroupConfig: "WITH_INITIAL_OWNER",
* parent: "customers/A01b123xz",
* groupKey: {
* id: "my-identity-group@example.com",
* },
* labels: {
* "cloudidentity.googleapis.com/groups.discussion_forum": "",
* },
* });
* ```
*
* ## Import
*
* Group can be imported using any of these accepted formats:
*
* * `{{name}}`
*
* When using the `pulumi import` command, Group can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:cloudidentity/group:Group default {{name}}
* ```
*/
class Group extends pulumi.CustomResource {
/**
* Get an existing Group 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 Group(name, state, Object.assign(Object.assign({}, opts), { id: id }));
}
/**
* Returns true if the given object is an instance of Group. 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'] === Group.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["additionalGroupKeys"] = state ? state.additionalGroupKeys : undefined;
resourceInputs["createTime"] = state ? state.createTime : undefined;
resourceInputs["description"] = state ? state.description : undefined;
resourceInputs["displayName"] = state ? state.displayName : undefined;
resourceInputs["groupKey"] = state ? state.groupKey : undefined;
resourceInputs["initialGroupConfig"] = state ? state.initialGroupConfig : undefined;
resourceInputs["labels"] = state ? state.labels : undefined;
resourceInputs["name"] = state ? state.name : undefined;
resourceInputs["parent"] = state ? state.parent : undefined;
resourceInputs["updateTime"] = state ? state.updateTime : undefined;
}
else {
const args = argsOrState;
if ((!args || args.groupKey === undefined) && !opts.urn) {
throw new Error("Missing required property 'groupKey'");
}
if ((!args || args.labels === undefined) && !opts.urn) {
throw new Error("Missing required property 'labels'");
}
if ((!args || args.parent === undefined) && !opts.urn) {
throw new Error("Missing required property 'parent'");
}
resourceInputs["description"] = args ? args.description : undefined;
resourceInputs["displayName"] = args ? args.displayName : undefined;
resourceInputs["groupKey"] = args ? args.groupKey : undefined;
resourceInputs["initialGroupConfig"] = args ? args.initialGroupConfig : undefined;
resourceInputs["labels"] = args ? args.labels : undefined;
resourceInputs["parent"] = args ? args.parent : undefined;
resourceInputs["additionalGroupKeys"] = undefined /*out*/;
resourceInputs["createTime"] = undefined /*out*/;
resourceInputs["name"] = undefined /*out*/;
resourceInputs["updateTime"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(Group.__pulumiType, name, resourceInputs, opts);
}
}
exports.Group = Group;
/** @internal */
Group.__pulumiType = 'gcp:cloudidentity/group:Group';
//# sourceMappingURL=group.js.map