@lbrlabs/pulumi-scaleway
Version:
A Pulumi package for creating and managing scaleway cloud resources.
107 lines (106 loc) • 3.89 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Add members to an IAM group.
* For more information, see [the documentation](https://developers.scaleway.com/en/products/iam/api/v1alpha1/#groups-f592eb).
*
* ## Examples
*
* ### Application Membership
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@lbrlabs/pulumi-scaleway";
*
* const group = new scaleway.IamGroup("group", {externalMembership: true});
* const app = new scaleway.IamApplication("app", {});
* const member = new scaleway.IamGroupMembership("member", {
* groupId: group.id,
* applicationId: app.id,
* });
* ```
*
* ## Import
*
* IAM group memberships can be imported using two format- For user`{group_id}/user/{user_id}` - For application`{group_id}/app/{application_id}` bash
*
* ```sh
* $ pulumi import scaleway:index/iamGroupMembership:IamGroupMembership app 11111111-1111-1111-1111-111111111111/app/11111111-1111-1111-1111-111111111111
* ```
*/
export declare class IamGroupMembership extends pulumi.CustomResource {
/**
* Get an existing IamGroupMembership 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: string, id: pulumi.Input<pulumi.ID>, state?: IamGroupMembershipState, opts?: pulumi.CustomResourceOptions): IamGroupMembership;
/**
* Returns true if the given object is an instance of IamGroupMembership. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is IamGroupMembership;
/**
* The ID of the application that will be added to the group.
*/
readonly applicationId: pulumi.Output<string | undefined>;
/**
* ID of the group to add members to.
*/
readonly groupId: pulumi.Output<string>;
/**
* The ID of the user that will be added to the group
*
* - > Only one of `applicationId` or `userId` must be specified
*/
readonly userId: pulumi.Output<string | undefined>;
/**
* Create a IamGroupMembership resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: IamGroupMembershipArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering IamGroupMembership resources.
*/
export interface IamGroupMembershipState {
/**
* The ID of the application that will be added to the group.
*/
applicationId?: pulumi.Input<string>;
/**
* ID of the group to add members to.
*/
groupId?: pulumi.Input<string>;
/**
* The ID of the user that will be added to the group
*
* - > Only one of `applicationId` or `userId` must be specified
*/
userId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a IamGroupMembership resource.
*/
export interface IamGroupMembershipArgs {
/**
* The ID of the application that will be added to the group.
*/
applicationId?: pulumi.Input<string>;
/**
* ID of the group to add members to.
*/
groupId: pulumi.Input<string>;
/**
* The ID of the user that will be added to the group
*
* - > Only one of `applicationId` or `userId` must be specified
*/
userId?: pulumi.Input<string>;
}