@pulumi/sumologic
Version:
A Pulumi package for creating and managing sumologic cloud resources.
119 lines (118 loc) • 4.9 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "./types/output";
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as sumologic from "@pulumi/sumologic";
*
* const _this = sumologic.getRoleV2({
* name: "MyRole",
* });
* ```
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as sumologic from "@pulumi/sumologic";
*
* const that = sumologic.getRoleV2({
* id: "1234567890",
* });
* ```
*
* A role can be looked up by either `id` or `name`. One of those attributes needs to be specified.
*
* If both `id` and `name` have been specified, `id` takes precedence.
*
* ## Attributes reference
*
* The following attributes are exported:
*
* - `id` - The internal ID of the role. This can be used to create users having that role.
* - `name` - The name of the role.
* - `description` - The description of the role.
* - `capabilities` - The list of capabilities associated with the role.
* - `selectedViews` - List of views with specific view level filters in accordance to the selectionType chosen.
* - `auditDataFilter` - The search filter which would be applied on partitions which belong to Audit Data product area. Help Doc : (https://help.sumologic.com/docs/manage/security/audit-index/).
* - `securityDataFilter` - The search filter which would be applied on partitions which belong to Security Data product area.
* - `logAnalyticsFilter` - The search filter which would be applied on partitions which belong to Log Analytics product area.
* - `selectionType` - Describes the Permission Construct for the list of views in "selectedViews" parameter.
* ### Values in selection type are :
* - `All` selectionType would allow access to all views in the org.
* - `Allow` selectionType would allow access to specific views mentioned in "selectedViews" parameter.
* - `Deny` selectionType would deny access to specific views mentioned in "selectedViews" parameter.
*/
export declare function getRoleV2(args?: GetRoleV2Args, opts?: pulumi.InvokeOptions): Promise<GetRoleV2Result>;
/**
* A collection of arguments for invoking getRoleV2.
*/
export interface GetRoleV2Args {
id?: string;
name?: string;
}
/**
* A collection of values returned by getRoleV2.
*/
export interface GetRoleV2Result {
readonly auditDataFilter: string;
readonly capabilities: string[];
readonly description: string;
readonly id: string;
readonly logAnalyticsFilter: string;
readonly name: string;
readonly securityDataFilter: string;
readonly selectedViews: outputs.GetRoleV2SelectedView[];
readonly selectionType: string;
}
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as sumologic from "@pulumi/sumologic";
*
* const _this = sumologic.getRoleV2({
* name: "MyRole",
* });
* ```
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as sumologic from "@pulumi/sumologic";
*
* const that = sumologic.getRoleV2({
* id: "1234567890",
* });
* ```
*
* A role can be looked up by either `id` or `name`. One of those attributes needs to be specified.
*
* If both `id` and `name` have been specified, `id` takes precedence.
*
* ## Attributes reference
*
* The following attributes are exported:
*
* - `id` - The internal ID of the role. This can be used to create users having that role.
* - `name` - The name of the role.
* - `description` - The description of the role.
* - `capabilities` - The list of capabilities associated with the role.
* - `selectedViews` - List of views with specific view level filters in accordance to the selectionType chosen.
* - `auditDataFilter` - The search filter which would be applied on partitions which belong to Audit Data product area. Help Doc : (https://help.sumologic.com/docs/manage/security/audit-index/).
* - `securityDataFilter` - The search filter which would be applied on partitions which belong to Security Data product area.
* - `logAnalyticsFilter` - The search filter which would be applied on partitions which belong to Log Analytics product area.
* - `selectionType` - Describes the Permission Construct for the list of views in "selectedViews" parameter.
* ### Values in selection type are :
* - `All` selectionType would allow access to all views in the org.
* - `Allow` selectionType would allow access to specific views mentioned in "selectedViews" parameter.
* - `Deny` selectionType would deny access to specific views mentioned in "selectedViews" parameter.
*/
export declare function getRoleV2Output(args?: GetRoleV2OutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetRoleV2Result>;
/**
* A collection of arguments for invoking getRoleV2.
*/
export interface GetRoleV2OutputArgs {
id?: pulumi.Input<string>;
name?: pulumi.Input<string>;
}