@lbrlabs/pulumi-scaleway
Version:
A Pulumi package for creating and managing scaleway cloud resources.
165 lines (164 loc) • 5.49 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Creates and manages Scaleway IAM Groups.
* For more information, see [the documentation](https://developers.scaleway.com/en/products/iam/api/v1alpha1/#groups-f592eb).
*
* ## Examples
*
* ### Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@lbrlabs/pulumi-scaleway";
*
* const basic = new scaleway.IamGroup("basic", {
* applicationIds: [],
* description: "basic description",
* userIds: [],
* });
* ```
*
* ### With applications
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@lbrlabs/pulumi-scaleway";
*
* const app = new scaleway.IamApplication("app", {});
* const withApp = new scaleway.IamGroup("withApp", {
* applicationIds: [app.id],
* userIds: [],
* });
* ```
*
* ## Import
*
* IAM groups can be imported using the `{id}`, e.g. bash
*
* ```sh
* $ pulumi import scaleway:index/iamGroup:IamGroup basic 11111111-1111-1111-1111-111111111111
* ```
*/
export declare class IamGroup extends pulumi.CustomResource {
/**
* Get an existing IamGroup 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?: IamGroupState, opts?: pulumi.CustomResourceOptions): IamGroup;
/**
* Returns true if the given object is an instance of IamGroup. 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 IamGroup;
/**
* The list of IDs of the applications attached to the group.
*/
readonly applicationIds: pulumi.Output<string[] | undefined>;
/**
* The date and time of the creation of the group
*/
readonly createdAt: pulumi.Output<string>;
/**
* The description of the IAM group.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Manage membership externally. This make the resource ignore userIds and application_ids. Should be used when using iam_group_membership
*/
readonly externalMembership: pulumi.Output<boolean | undefined>;
/**
* The name of the IAM group.
*/
readonly name: pulumi.Output<string>;
/**
* `organizationId`) The ID of the organization the group is associated with.
*/
readonly organizationId: pulumi.Output<string>;
/**
* The date and time of the last update of the group
*/
readonly updatedAt: pulumi.Output<string>;
/**
* The list of IDs of the users attached to the group.
*/
readonly userIds: pulumi.Output<string[] | undefined>;
/**
* Create a IamGroup 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?: IamGroupArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering IamGroup resources.
*/
export interface IamGroupState {
/**
* The list of IDs of the applications attached to the group.
*/
applicationIds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The date and time of the creation of the group
*/
createdAt?: pulumi.Input<string>;
/**
* The description of the IAM group.
*/
description?: pulumi.Input<string>;
/**
* Manage membership externally. This make the resource ignore userIds and application_ids. Should be used when using iam_group_membership
*/
externalMembership?: pulumi.Input<boolean>;
/**
* The name of the IAM group.
*/
name?: pulumi.Input<string>;
/**
* `organizationId`) The ID of the organization the group is associated with.
*/
organizationId?: pulumi.Input<string>;
/**
* The date and time of the last update of the group
*/
updatedAt?: pulumi.Input<string>;
/**
* The list of IDs of the users attached to the group.
*/
userIds?: pulumi.Input<pulumi.Input<string>[]>;
}
/**
* The set of arguments for constructing a IamGroup resource.
*/
export interface IamGroupArgs {
/**
* The list of IDs of the applications attached to the group.
*/
applicationIds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The description of the IAM group.
*/
description?: pulumi.Input<string>;
/**
* Manage membership externally. This make the resource ignore userIds and application_ids. Should be used when using iam_group_membership
*/
externalMembership?: pulumi.Input<boolean>;
/**
* The name of the IAM group.
*/
name?: pulumi.Input<string>;
/**
* `organizationId`) The ID of the organization the group is associated with.
*/
organizationId?: pulumi.Input<string>;
/**
* The list of IDs of the users attached to the group.
*/
userIds?: pulumi.Input<pulumi.Input<string>[]>;
}