@pulumi/sumologic/role.d.ts

A Pulumi package for creating and managing sumologic cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Provides a [Sumologic Role](https://help.sumologic.com/Manage/Users-and-Roles/Manage-Roles).
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as sumologic from "@pulumi/sumologic";
 *
 * const exampleRole = new sumologic.Role("example_role", {
 *     name: "TestRole123",
 *     description: "Testing resource sumologic_role",
 *     filterPredicate: "_sourceCategory=Test",
 *     capabilities: ["manageCollectors"],
 * });
 * ```
 *
 * ## Import
 *
 * Roles can be imported using the role id, e.g.:
 *
 * hcl
 *
 * ```sh
 * $ pulumi import sumologic:index/role:Role role 1234567890
 * ```
 *
 * [1]: https://help.sumologic.com/Manage/Users-and-Roles/Manage-Roles
 *
 * [2]: https://api.sumologic.com/docs/#operation/createRole
 */
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;
    /**
     * List of capabilities associated with this role. For a complete list of capability names, please see `capabilities` field in the request of [CreateRole](https://api.sumologic.com/docs/#operation/createRole) endpoint.
     *
     * The following attributes are exported:
     */
    readonly capabilities: pulumi.Output<string[] | undefined>;
    /**
     * The description of the role.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * A search filter to restrict access to specific logs.
     */
    readonly filterPredicate: pulumi.Output<string | undefined>;
    /**
     * The name of the role.
     */
    readonly name: pulumi.Output<string>;
    /**
     * 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 {
    /**
     * List of capabilities associated with this role. For a complete list of capability names, please see `capabilities` field in the request of [CreateRole](https://api.sumologic.com/docs/#operation/createRole) endpoint.
     *
     * The following attributes are exported:
     */
    capabilities?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * The description of the role.
     */
    description?: pulumi.Input<string>;
    /**
     * A search filter to restrict access to specific logs.
     */
    filterPredicate?: pulumi.Input<string>;
    /**
     * The name of the role.
     */
    name?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a Role resource.
 */
export interface RoleArgs {
    /**
     * List of capabilities associated with this role. For a complete list of capability names, please see `capabilities` field in the request of [CreateRole](https://api.sumologic.com/docs/#operation/createRole) endpoint.
     *
     * The following attributes are exported:
     */
    capabilities?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * The description of the role.
     */
    description?: pulumi.Input<string>;
    /**
     * A search filter to restrict access to specific logs.
     */
    filterPredicate?: pulumi.Input<string>;
    /**
     * The name of the role.
     */
    name?: pulumi.Input<string>;
}