@pierskarsenbarg/sdm/role.d.ts

A Pulumi package for creating and managing StrongDM cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * A Role has a list of access rules which determine which Resources the members
 *  of the Role have access to. An Account can be a member of multiple Roles via
 *  AccountAttachments.
 * ## Example Usage
 *
 * <!--Start PulumiCodeChooser -->
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as sdm from "@pierskarsenbarg/sdm";
 *
 * const engineers = new sdm.Role("engineers", {
 *     name: "engineers",
 *     tags: {
 *         foo: "bar",
 *     },
 * });
 * const example_role = new sdm.Role("example-role", {
 *     name: "example-role",
 *     accessRules: JSON.stringify([
 *         {
 *             tags: {
 *                 env: "staging",
 *             },
 *         },
 *         {
 *             type: "postgres",
 *             tags: {
 *                 region: "us-west",
 *                 env: "dev",
 *             },
 *         },
 *         {
 *             ids: ["rs-093e6f3061eb4dad"],
 *         },
 *     ]),
 * });
 * const k8s_admin = new sdm.Role("k8s-admin", {
 *     name: "k8s-admin",
 *     accessRules: JSON.stringify([{
 *         tags: {
 *             env: "production",
 *         },
 *         privileges: {
 *             k8s: {
 *                 groups: ["system:masters"],
 *             },
 *         },
 *     }]),
 * });
 * const k8s_developers = new sdm.Role("k8s-developers", {
 *     name: "k8s-developers",
 *     accessRules: JSON.stringify([
 *         {
 *             type: "amazon_eks",
 *             tags: {
 *                 env: "dev",
 *             },
 *             privileges: {
 *                 k8s: {
 *                     groups: [
 *                         "developers",
 *                         "viewers",
 *                     ],
 *                 },
 *             },
 *         },
 *         {
 *             type: "kubernetes",
 *             tags: {
 *                 region: "us-west",
 *             },
 *             privileges: {
 *                 k8s: {
 *                     groups: ["edit"],
 *                 },
 *             },
 *         },
 *     ]),
 * });
 * ```
 * <!--End PulumiCodeChooser -->
 * This resource can be imported using the import command.
 *
 * ## Import
 *
 * A Role can be imported using the id, e.g.,
 *
 * ```sh
 * $ pulumi import sdm:index/role:Role example r-12345678
 * ```
 */
export declare class Role extends pulumi.CustomResource {
    /**
     * Get an existing Role 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?: RoleState, opts?: pulumi.CustomResourceOptions): Role;
    /**
     * Returns true if the given object is an instance of Role.  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 Role;
    /**
     * AccessRules is a list of access rules defining the resources this Role has access to.
     */
    readonly accessRules: pulumi.Output<string>;
    /**
     * Managed By is a read only field for what service manages this role, e.g. StrongDM, Okta, Azure.
     */
    readonly managedBy: pulumi.Output<string>;
    /**
     * Unique human-readable name of the Role.
     */
    readonly name: pulumi.Output<string>;
    /**
     * Tags is a map of key, value pairs.
     */
    readonly tags: pulumi.Output<{
        [key: string]: string;
    } | undefined>;
    /**
     * Create a Role 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?: RoleArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Role resources.
 */
export interface RoleState {
    /**
     * AccessRules is a list of access rules defining the resources this Role has access to.
     */
    accessRules?: pulumi.Input<string | undefined>;
    /**
     * Managed By is a read only field for what service manages this role, e.g. StrongDM, Okta, Azure.
     */
    managedBy?: pulumi.Input<string | undefined>;
    /**
     * Unique human-readable name of the Role.
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * Tags is a map of key, value pairs.
     */
    tags?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    } | undefined>;
}
/**
 * The set of arguments for constructing a Role resource.
 */
export interface RoleArgs {
    /**
     * AccessRules is a list of access rules defining the resources this Role has access to.
     */
    accessRules?: pulumi.Input<string | undefined>;
    /**
     * Unique human-readable name of the Role.
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * Tags is a map of key, value pairs.
     */
    tags?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    } | undefined>;
}
//# sourceMappingURL=role.d.ts.map