@pierskarsenbarg/sdm
Version:
A Pulumi package for creating and managing StrongDM cloud resources.
116 lines • 3.82 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* A Group is a named set of principals.
* ## Example Usage
*
* <!--Start PulumiCodeChooser -->
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as sdm from "@pierskarsenbarg/sdm";
*
* const securityTeam = new sdm.Group("security_team", {
* name: "Security Team",
* tags: {
* admin: "true",
* },
* });
* const administrators = new sdm.Group("administrators", {name: "Administrators"});
* const devopsTeam = new sdm.Group("devops_team", {name: "DevOps Team"});
* ```
* <!--End PulumiCodeChooser -->
* This resource can be imported using the import command.
*
* ## Import
*
* A Group can be imported using the id, e.g.,
*
* ```sh
* $ pulumi import sdm:index/group:Group example group-12345678
* ```
*/
export declare 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: string, id: pulumi.Input<pulumi.ID>, state?: GroupState, opts?: pulumi.CustomResourceOptions): Group;
/**
* 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: any): obj is Group;
/**
* Description of the Group.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Unique human-readable name of the Group.
*/
readonly name: pulumi.Output<string>;
/**
* Source is a read only field for what service manages this group, e.g. StrongDM, Okta, Azure.
*/
readonly source: pulumi.Output<string>;
/**
* Tags is a map of key/value pairs that can be attached to a Group.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Create a Group 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?: GroupArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Group resources.
*/
export interface GroupState {
/**
* Description of the Group.
*/
description?: pulumi.Input<string | undefined>;
/**
* Unique human-readable name of the Group.
*/
name?: pulumi.Input<string | undefined>;
/**
* Source is a read only field for what service manages this group, e.g. StrongDM, Okta, Azure.
*/
source?: pulumi.Input<string | undefined>;
/**
* Tags is a map of key/value pairs that can be attached to a Group.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
}
/**
* The set of arguments for constructing a Group resource.
*/
export interface GroupArgs {
/**
* Description of the Group.
*/
description?: pulumi.Input<string | undefined>;
/**
* Unique human-readable name of the Group.
*/
name?: pulumi.Input<string | undefined>;
/**
* Tags is a map of key/value pairs that can be attached to a Group.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
}
//# sourceMappingURL=group.d.ts.map