@pulumi/sumologic
Version:
A Pulumi package for creating and managing sumologic cloud resources.
131 lines • 5.4 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.User = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("./utilities");
/**
* Provides a [Sumologic User](https://help.sumologic.com/Manage/Users-and-Roles/Manage-Users).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as sumologic from "@pulumi/sumologic";
*
* const exampleRole = new sumologic.Role("example_role", {
* name: "TestRole123",
* description: "Testing resource sumologic_role",
* });
* const exampleUser1 = new sumologic.User("example_user1", {
* firstName: "Jon",
* lastName: "Doe",
* email: "jon.doe@gmail.com",
* isActive: true,
* roleIds: [exampleRole.id],
* transferTo: "",
* });
* const exampleUser2 = new sumologic.User("example_user2", {
* firstName: "Jane",
* lastName: "Smith",
* email: "jane.smith@gmail.com",
* roleIds: [exampleRole.id],
* transferTo: exampleUser1.id,
* });
* ```
*
* ## Transfered content and email updates
*
* When a user is deleted, all of that user's content is transferred to another user. If `transferTo` is
* set to another user's ID, then the content will be assigned to that user. If `transferTo` is empty,
* then it will instead be assigned to the user executing the delete operation.
*
* A user's email address may not be changed. As a workaround, you may:
*
* 1. create a new `sumologic.User` with the desired email address
* 2. set the `transferTo` of the existing user to the new user's ID
* 3. delete the user with the old email address
*
* [1]: https://help.sumologic.com/Manage/Users-and-Roles/Manage-Users
*
* ## Import
*
* Users can be imported using the user id, e.g.:
*
* hcl
*
* ```sh
* $ pulumi import sumologic:index/user:User user 1234567890
* ```
*/
class User extends pulumi.CustomResource {
/**
* Get an existing User 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 User(name, state, Object.assign(Object.assign({}, opts), { id: id }));
}
/**
* Returns true if the given object is an instance of User. 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'] === User.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["email"] = state ? state.email : undefined;
resourceInputs["firstName"] = state ? state.firstName : undefined;
resourceInputs["isActive"] = state ? state.isActive : undefined;
resourceInputs["lastName"] = state ? state.lastName : undefined;
resourceInputs["roleIds"] = state ? state.roleIds : undefined;
resourceInputs["transferTo"] = state ? state.transferTo : undefined;
}
else {
const args = argsOrState;
if ((!args || args.email === undefined) && !opts.urn) {
throw new Error("Missing required property 'email'");
}
if ((!args || args.firstName === undefined) && !opts.urn) {
throw new Error("Missing required property 'firstName'");
}
if ((!args || args.isActive === undefined) && !opts.urn) {
throw new Error("Missing required property 'isActive'");
}
if ((!args || args.lastName === undefined) && !opts.urn) {
throw new Error("Missing required property 'lastName'");
}
if ((!args || args.roleIds === undefined) && !opts.urn) {
throw new Error("Missing required property 'roleIds'");
}
if ((!args || args.transferTo === undefined) && !opts.urn) {
throw new Error("Missing required property 'transferTo'");
}
resourceInputs["email"] = args ? args.email : undefined;
resourceInputs["firstName"] = args ? args.firstName : undefined;
resourceInputs["isActive"] = args ? args.isActive : undefined;
resourceInputs["lastName"] = args ? args.lastName : undefined;
resourceInputs["roleIds"] = args ? args.roleIds : undefined;
resourceInputs["transferTo"] = args ? args.transferTo : undefined;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(User.__pulumiType, name, resourceInputs, opts);
}
}
exports.User = User;
/** @internal */
User.__pulumiType = 'sumologic:index/user:User';
//# sourceMappingURL=user.js.map