Docs Packages
  1. Packages
  2. Sumo Logic
  3. API Docs
  4. Role
Sumo Logic v0.22.1 published on Sunday, Jun 9, 2024 by Pulumi
pulumi/pulumi-sumologic

sumologic.Role

Explore with Pulumi AI

sumologic logo
Sumo Logic v0.22.1 published on Sunday, Jun 9, 2024 by Pulumi
pulumi/pulumi-sumologic

    Provides a Sumologic Role.

    Example Usage

    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 pulumi
import pulumi_sumologic as sumologic

example_role = sumologic.Role("example_role",
    name="TestRole123",
    description="Testing resource sumologic_role",
    filter_predicate="_sourceCategory=Test",
    capabilities=["manageCollectors"])

    package main

import (
	"github.com/pulumi/pulumi-sumologic/sdk/go/sumologic"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sumologic.NewRole(ctx, "example_role", &sumologic.RoleArgs{
			Name:            pulumi.String("TestRole123"),
			Description:     pulumi.String("Testing resource sumologic_role"),
			FilterPredicate: pulumi.String("_sourceCategory=Test"),
			Capabilities: pulumi.StringArray{
				pulumi.String("manageCollectors"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using SumoLogic = Pulumi.SumoLogic;

return await Deployment.RunAsync(() => 
{
    var exampleRole = new SumoLogic.Role("example_role", new()
    {
        Name = "TestRole123",
        Description = "Testing resource sumologic_role",
        FilterPredicate = "_sourceCategory=Test",
        Capabilities = new[]
        {
            "manageCollectors",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.sumologic.Role;
import com.pulumi.sumologic.RoleArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var exampleRole = new Role("exampleRole", RoleArgs.builder()
            .name("TestRole123")
            .description("Testing resource sumologic_role")
            .filterPredicate("_sourceCategory=Test")
            .capabilities("manageCollectors")
            .build());

    }
}

    resources:
  exampleRole:
    type: sumologic:Role
    name: example_role
    properties:
      name: TestRole123
      description: Testing resource sumologic_role
      filterPredicate: _sourceCategory=Test
      capabilities:
        - manageCollectors

    Create Role Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Role(name: string, args?: RoleArgs, opts?: CustomResourceOptions);
    @overload
def Role(resource_name: str,
         args: Optional[RoleArgs] = None,
         opts: Optional[ResourceOptions] = None)

@overload
def Role(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         capabilities: Optional[Sequence[str]] = None,
         description: Optional[str] = None,
         filter_predicate: Optional[str] = None,
         name: Optional[str] = None)
    func NewRole(ctx *Context, name string, args *RoleArgs, opts ...ResourceOption) (*Role, error)
    public Role(string name, RoleArgs? args = null, CustomResourceOptions? opts = null)
    public Role(String name, RoleArgs args)
public Role(String name, RoleArgs args, CustomResourceOptions options)

    type: sumologic:Role
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args RoleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args RoleArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args RoleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RoleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RoleArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var roleResource = new SumoLogic.Role("roleResource", new()
{
    Capabilities = new[]
    {
        "string",
    },
    Description = "string",
    FilterPredicate = "string",
    Name = "string",
});

    example, err := sumologic.NewRole(ctx, "roleResource", &sumologic.RoleArgs{
	Capabilities: pulumi.StringArray{
		pulumi.String("string"),
	},
	Description:     pulumi.String("string"),
	FilterPredicate: pulumi.String("string"),
	Name:            pulumi.String("string"),
})

    var roleResource = new Role("roleResource", RoleArgs.builder()
    .capabilities("string")
    .description("string")
    .filterPredicate("string")
    .name("string")
    .build());

    role_resource = sumologic.Role("roleResource",
    capabilities=["string"],
    description="string",
    filter_predicate="string",
    name="string")

    const roleResource = new sumologic.Role("roleResource", {
    capabilities: ["string"],
    description: "string",
    filterPredicate: "string",
    name: "string",
});

    type: sumologic:Role
properties:
    capabilities:
        - string
    description: string
    filterPredicate: string
    name: string

    Role Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Role resource accepts the following input properties:

    Capabilities List<string>

    List of capabilities associated with this role. For a complete list of capability names, please see capabilities field in the request of CreateRole endpoint.

    The following attributes are exported:

    Description string
    The description of the role.
    FilterPredicate string
    A search filter to restrict access to specific logs.
    Name string
    The name of the role.
    Capabilities []string

    List of capabilities associated with this role. For a complete list of capability names, please see capabilities field in the request of CreateRole endpoint.

    The following attributes are exported:

    Description string
    The description of the role.
    FilterPredicate string
    A search filter to restrict access to specific logs.
    Name string
    The name of the role.
    capabilities List<String>

    List of capabilities associated with this role. For a complete list of capability names, please see capabilities field in the request of CreateRole endpoint.

    The following attributes are exported:

    description String
    The description of the role.
    filterPredicate String
    A search filter to restrict access to specific logs.
    name String
    The name of the role.
    capabilities string[]

    List of capabilities associated with this role. For a complete list of capability names, please see capabilities field in the request of CreateRole endpoint.

    The following attributes are exported:

    description string
    The description of the role.
    filterPredicate string
    A search filter to restrict access to specific logs.
    name string
    The name of the role.
    capabilities Sequence[str]

    List of capabilities associated with this role. For a complete list of capability names, please see capabilities field in the request of CreateRole endpoint.

    The following attributes are exported:

    description str
    The description of the role.
    filter_predicate str
    A search filter to restrict access to specific logs.
    name str
    The name of the role.
    capabilities List<String>

    List of capabilities associated with this role. For a complete list of capability names, please see capabilities field in the request of CreateRole endpoint.

    The following attributes are exported:

    description String
    The description of the role.
    filterPredicate String
    A search filter to restrict access to specific logs.
    name String
    The name of the role.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Role resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Role Resource

    Get an existing Role resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: RoleState, opts?: CustomResourceOptions): Role
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        capabilities: Optional[Sequence[str]] = None,
        description: Optional[str] = None,
        filter_predicate: Optional[str] = None,
        name: Optional[str] = None) -> Role
    func GetRole(ctx *Context, name string, id IDInput, state *RoleState, opts ...ResourceOption) (*Role, error)
    public static Role Get(string name, Input<string> id, RoleState? state, CustomResourceOptions? opts = null)
    public static Role get(String name, Output<String> id, RoleState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Capabilities List<string>

    List of capabilities associated with this role. For a complete list of capability names, please see capabilities field in the request of CreateRole endpoint.

    The following attributes are exported:

    Description string
    The description of the role.
    FilterPredicate string
    A search filter to restrict access to specific logs.
    Name string
    The name of the role.
    Capabilities []string

    List of capabilities associated with this role. For a complete list of capability names, please see capabilities field in the request of CreateRole endpoint.

    The following attributes are exported:

    Description string
    The description of the role.
    FilterPredicate string
    A search filter to restrict access to specific logs.
    Name string
    The name of the role.
    capabilities List<String>

    List of capabilities associated with this role. For a complete list of capability names, please see capabilities field in the request of CreateRole endpoint.

    The following attributes are exported:

    description String
    The description of the role.
    filterPredicate String
    A search filter to restrict access to specific logs.
    name String
    The name of the role.
    capabilities string[]

    List of capabilities associated with this role. For a complete list of capability names, please see capabilities field in the request of CreateRole endpoint.

    The following attributes are exported:

    description string
    The description of the role.
    filterPredicate string
    A search filter to restrict access to specific logs.
    name string
    The name of the role.
    capabilities Sequence[str]

    List of capabilities associated with this role. For a complete list of capability names, please see capabilities field in the request of CreateRole endpoint.

    The following attributes are exported:

    description str
    The description of the role.
    filter_predicate str
    A search filter to restrict access to specific logs.
    name str
    The name of the role.
    capabilities List<String>

    List of capabilities associated with this role. For a complete list of capability names, please see capabilities field in the request of CreateRole endpoint.

    The following attributes are exported:

    description String
    The description of the role.
    filterPredicate String
    A search filter to restrict access to specific logs.
    name String
    The name of the role.

    Import

    Roles can be imported using the role id, e.g.:

    hcl

    $ pulumi import sumologic:index/role:Role role 1234567890

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Sumo Logic pulumi/pulumi-sumologic
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the sumologic Terraform Provider.
    sumologic logo
    Sumo Logic v0.22.1 published on Sunday, Jun 9, 2024 by Pulumi
    pulumi/pulumi-sumologic