UNPKG

@pulumi/aws

Version:

A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.

96 lines 3.69 kB
"use strict"; // *** WARNING: this file was generated by pulumi-language-nodejs. *** // *** Do not edit by hand unless you're certain you know what you are doing! *** Object.defineProperty(exports, "__esModule", { value: true }); exports.UserGroupMembership = void 0; const pulumi = require("@pulumi/pulumi"); const utilities = require("../utilities"); /** * Provides a resource for adding an IAM User to IAM Groups. This * resource can be used multiple times with the same user for non-overlapping * groups. * * To exclusively manage the users in a group, see the * `aws.iam.GroupMembership` resource. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const user1 = new aws.iam.User("user1", {name: "user1"}); * const group1 = new aws.iam.Group("group1", {name: "group1"}); * const group2 = new aws.iam.Group("group2", {name: "group2"}); * const example1 = new aws.iam.UserGroupMembership("example1", { * user: user1.name, * groups: [ * group1.name, * group2.name, * ], * }); * const group3 = new aws.iam.Group("group3", {name: "group3"}); * const example2 = new aws.iam.UserGroupMembership("example2", { * user: user1.name, * groups: [group3.name], * }); * ``` * * ## Import * * Using `pulumi import`, import IAM user group membership using the user name and group names separated by `/`. For example: * * ```sh * $ pulumi import aws:iam/userGroupMembership:UserGroupMembership example1 user1/group1/group2 * ``` */ class UserGroupMembership extends pulumi.CustomResource { /** * Get an existing UserGroupMembership 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 UserGroupMembership(name, state, { ...opts, id: id }); } /** * Returns true if the given object is an instance of UserGroupMembership. 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'] === UserGroupMembership.__pulumiType; } constructor(name, argsOrState, opts) { let resourceInputs = {}; opts = opts || {}; if (opts.id) { const state = argsOrState; resourceInputs["groups"] = state?.groups; resourceInputs["user"] = state?.user; } else { const args = argsOrState; if (args?.groups === undefined && !opts.urn) { throw new Error("Missing required property 'groups'"); } if (args?.user === undefined && !opts.urn) { throw new Error("Missing required property 'user'"); } resourceInputs["groups"] = args?.groups; resourceInputs["user"] = args?.user; } opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts); super(UserGroupMembership.__pulumiType, name, resourceInputs, opts); } } exports.UserGroupMembership = UserGroupMembership; /** @internal */ UserGroupMembership.__pulumiType = 'aws:iam/userGroupMembership:UserGroupMembership'; //# sourceMappingURL=userGroupMembership.js.map