1. Packages
  2. Sysdig Provider
  3. API Docs
  4. getCustomRole
Viewing docs for sysdig 3.5.0
published on Friday, Mar 6, 2026 by sysdiglabs
Schema (JSON)
sysdiglabs/terraform-provider-sysdig

sysdig.getCustomRole

sysdig logo
Viewing docs for sysdig 3.5.0
published on Friday, Mar 6, 2026 by sysdiglabs
Schema (JSON)
sysdiglabs/terraform-provider-sysdig

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as sysdig from "@pulumi/sysdig";

const customRole = sysdig.getCustomRole({
    name: "CustomRoleName",
});

    import pulumi
import pulumi_sysdig as sysdig

custom_role = sysdig.get_custom_role(name="CustomRoleName")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/sysdig/v3/sysdig"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sysdig.LookupCustomRole(ctx, &sysdig.LookupCustomRoleArgs{
			Name: "CustomRoleName",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var customRole = Sysdig.GetCustomRole.Invoke(new()
    {
        Name = "CustomRoleName",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.sysdig.SysdigFunctions;
import com.pulumi.sysdig.inputs.GetCustomRoleArgs;
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) {
        final var customRole = SysdigFunctions.getCustomRole(GetCustomRoleArgs.builder()
            .name("CustomRoleName")
            .build());

    }
}

    variables:
  customRole:
    fn::invoke:
      function: sysdig:getCustomRole
      arguments:
        name: CustomRoleName

    Using getCustomRole

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getCustomRole(args: GetCustomRoleArgs, opts?: InvokeOptions): Promise<GetCustomRoleResult>
function getCustomRoleOutput(args: GetCustomRoleOutputArgs, opts?: InvokeOptions): Output<GetCustomRoleResult>
    def get_custom_role(id: Optional[str] = None,
                    name: Optional[str] = None,
                    timeouts: Optional[GetCustomRoleTimeouts] = None,
                    opts: Optional[InvokeOptions] = None) -> GetCustomRoleResult
def get_custom_role_output(id: Optional[pulumi.Input[str]] = None,
                    name: Optional[pulumi.Input[str]] = None,
                    timeouts: Optional[pulumi.Input[GetCustomRoleTimeoutsArgs]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetCustomRoleResult]
    func LookupCustomRole(ctx *Context, args *LookupCustomRoleArgs, opts ...InvokeOption) (*LookupCustomRoleResult, error)
func LookupCustomRoleOutput(ctx *Context, args *LookupCustomRoleOutputArgs, opts ...InvokeOption) LookupCustomRoleResultOutput

    > Note: This function is named LookupCustomRole in the Go SDK.

    public static class GetCustomRole 
{
    public static Task<GetCustomRoleResult> InvokeAsync(GetCustomRoleArgs args, InvokeOptions? opts = null)
    public static Output<GetCustomRoleResult> Invoke(GetCustomRoleInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetCustomRoleResult> getCustomRole(GetCustomRoleArgs args, InvokeOptions options)
public static Output<GetCustomRoleResult> getCustomRole(GetCustomRoleArgs args, InvokeOptions options)

    fn::invoke:
  function: sysdig:index/getCustomRole:getCustomRole
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string
    The custom role's name.
    Id string
    The custom role's ID.
    Timeouts GetCustomRoleTimeouts
    Name string
    The custom role's name.
    Id string
    The custom role's ID.
    Timeouts GetCustomRoleTimeouts
    name String
    The custom role's name.
    id String
    The custom role's ID.
    timeouts GetCustomRoleTimeouts
    name string
    The custom role's name.
    id string
    The custom role's ID.
    timeouts GetCustomRoleTimeouts
    name str
    The custom role's name.
    id str
    The custom role's ID.
    timeouts GetCustomRoleTimeouts
    name String
    The custom role's name.
    id String
    The custom role's ID.
    timeouts Property Map

    getCustomRole Result

    The following output properties are available:

    Description string
    The custom role's description.
    Id string
    The custom role's ID.
    MonitorPermissions List<string>
    The custom role's monitor permissions.
    Name string
    The custom role's name.
    SecurePermissions List<string>
    The custom role's secure permissions.
    Timeouts GetCustomRoleTimeouts
    Description string
    The custom role's description.
    Id string
    The custom role's ID.
    MonitorPermissions []string
    The custom role's monitor permissions.
    Name string
    The custom role's name.
    SecurePermissions []string
    The custom role's secure permissions.
    Timeouts GetCustomRoleTimeouts
    description String
    The custom role's description.
    id String
    The custom role's ID.
    monitorPermissions List<String>
    The custom role's monitor permissions.
    name String
    The custom role's name.
    securePermissions List<String>
    The custom role's secure permissions.
    timeouts GetCustomRoleTimeouts
    description string
    The custom role's description.
    id string
    The custom role's ID.
    monitorPermissions string[]
    The custom role's monitor permissions.
    name string
    The custom role's name.
    securePermissions string[]
    The custom role's secure permissions.
    timeouts GetCustomRoleTimeouts
    description str
    The custom role's description.
    id str
    The custom role's ID.
    monitor_permissions Sequence[str]
    The custom role's monitor permissions.
    name str
    The custom role's name.
    secure_permissions Sequence[str]
    The custom role's secure permissions.
    timeouts GetCustomRoleTimeouts
    description String
    The custom role's description.
    id String
    The custom role's ID.
    monitorPermissions List<String>
    The custom role's monitor permissions.
    name String
    The custom role's name.
    securePermissions List<String>
    The custom role's secure permissions.
    timeouts Property Map

    Supporting Types

    GetCustomRoleTimeouts

    Read string
    Read string
    read String
    read string
    read str
    read String

    Package Details

    Repository
    sysdig sysdiglabs/terraform-provider-sysdig
    License
    Notes
    This Pulumi package is based on the sysdig Terraform Provider.
    sysdig logo
    Viewing docs for sysdig 3.5.0
    published on Friday, Mar 6, 2026 by sysdiglabs
    Schema (JSON)
    sysdiglabs/terraform-provider-sysdig
      Try Pulumi Cloud free. Your team will thank you.