1. Packages
  2. Sysdig Provider
  3. API Docs
  4. User
sysdig 1.56.0 published on Wednesday, Apr 30, 2025 by sysdiglabs

sysdig.User

Explore with Pulumi AI

sysdig logo
sysdig 1.56.0 published on Wednesday, Apr 30, 2025 by sysdiglabs

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as sysdig from "@pulumi/sysdig";
    
    const foo_bar = new sysdig.User("foo-bar", {
        email: "foo.bar@sysdig.com",
        firstName: "foo",
        lastName: "bar",
        systemRole: "ROLE_CUSTOMER",
    });
    
    import pulumi
    import pulumi_sysdig as sysdig
    
    foo_bar = sysdig.User("foo-bar",
        email="foo.bar@sysdig.com",
        first_name="foo",
        last_name="bar",
        system_role="ROLE_CUSTOMER")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/sysdig/sysdig"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := sysdig.NewUser(ctx, "foo-bar", &sysdig.UserArgs{
    			Email:      pulumi.String("foo.bar@sysdig.com"),
    			FirstName:  pulumi.String("foo"),
    			LastName:   pulumi.String("bar"),
    			SystemRole: pulumi.String("ROLE_CUSTOMER"),
    		})
    		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 foo_bar = new Sysdig.User("foo-bar", new()
        {
            Email = "foo.bar@sysdig.com",
            FirstName = "foo",
            LastName = "bar",
            SystemRole = "ROLE_CUSTOMER",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.sysdig.User;
    import com.pulumi.sysdig.UserArgs;
    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 foo_bar = new User("foo-bar", UserArgs.builder()
                .email("foo.bar@sysdig.com")
                .firstName("foo")
                .lastName("bar")
                .systemRole("ROLE_CUSTOMER")
                .build());
    
        }
    }
    
    resources:
      foo-bar:
        type: sysdig:User
        properties:
          email: foo.bar@sysdig.com
          firstName: foo
          lastName: bar
          systemRole: ROLE_CUSTOMER
    

    Create User Resource

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

    Constructor syntax

    new User(name: string, args: UserArgs, opts?: CustomResourceOptions);
    @overload
    def User(resource_name: str,
             args: UserArgs,
             opts: Optional[ResourceOptions] = None)
    
    @overload
    def User(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             email: Optional[str] = None,
             first_name: Optional[str] = None,
             last_name: Optional[str] = None,
             system_role: Optional[str] = None,
             timeouts: Optional[UserTimeoutsArgs] = None,
             user_id: Optional[str] = None)
    func NewUser(ctx *Context, name string, args UserArgs, opts ...ResourceOption) (*User, error)
    public User(string name, UserArgs args, CustomResourceOptions? opts = null)
    public User(String name, UserArgs args)
    public User(String name, UserArgs args, CustomResourceOptions options)
    
    type: sysdig:User
    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 UserArgs
    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 UserArgs
    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 UserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserArgs
    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 userResource = new Sysdig.User("userResource", new()
    {
        Email = "string",
        FirstName = "string",
        LastName = "string",
        SystemRole = "string",
        Timeouts = new Sysdig.Inputs.UserTimeoutsArgs
        {
            Create = "string",
        },
        UserId = "string",
    });
    
    example, err := sysdig.NewUser(ctx, "userResource", &sysdig.UserArgs{
    	Email:      pulumi.String("string"),
    	FirstName:  pulumi.String("string"),
    	LastName:   pulumi.String("string"),
    	SystemRole: pulumi.String("string"),
    	Timeouts: &sysdig.UserTimeoutsArgs{
    		Create: pulumi.String("string"),
    	},
    	UserId: pulumi.String("string"),
    })
    
    var userResource = new User("userResource", UserArgs.builder()
        .email("string")
        .firstName("string")
        .lastName("string")
        .systemRole("string")
        .timeouts(UserTimeoutsArgs.builder()
            .create("string")
            .build())
        .userId("string")
        .build());
    
    user_resource = sysdig.User("userResource",
        email="string",
        first_name="string",
        last_name="string",
        system_role="string",
        timeouts={
            "create": "string",
        },
        user_id="string")
    
    const userResource = new sysdig.User("userResource", {
        email: "string",
        firstName: "string",
        lastName: "string",
        systemRole: "string",
        timeouts: {
            create: "string",
        },
        userId: "string",
    });
    
    type: sysdig:User
    properties:
        email: string
        firstName: string
        lastName: string
        systemRole: string
        timeouts:
            create: string
        userId: string
    

    User Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The User resource accepts the following input properties:

    Email string
    The email for the user to invite.
    FirstName string
    The name of the user.
    LastName string
    The last name of the user.
    SystemRole string
    The privileges for the user. It can be either "ROLE_USER" or "ROLE_CUSTOMER". If set to "ROLE_CUSTOMER", the user will be known as an admin.
    Timeouts UserTimeouts
    UserId string
    Email string
    The email for the user to invite.
    FirstName string
    The name of the user.
    LastName string
    The last name of the user.
    SystemRole string
    The privileges for the user. It can be either "ROLE_USER" or "ROLE_CUSTOMER". If set to "ROLE_CUSTOMER", the user will be known as an admin.
    Timeouts UserTimeoutsArgs
    UserId string
    email String
    The email for the user to invite.
    firstName String
    The name of the user.
    lastName String
    The last name of the user.
    systemRole String
    The privileges for the user. It can be either "ROLE_USER" or "ROLE_CUSTOMER". If set to "ROLE_CUSTOMER", the user will be known as an admin.
    timeouts UserTimeouts
    userId String
    email string
    The email for the user to invite.
    firstName string
    The name of the user.
    lastName string
    The last name of the user.
    systemRole string
    The privileges for the user. It can be either "ROLE_USER" or "ROLE_CUSTOMER". If set to "ROLE_CUSTOMER", the user will be known as an admin.
    timeouts UserTimeouts
    userId string
    email str
    The email for the user to invite.
    first_name str
    The name of the user.
    last_name str
    The last name of the user.
    system_role str
    The privileges for the user. It can be either "ROLE_USER" or "ROLE_CUSTOMER". If set to "ROLE_CUSTOMER", the user will be known as an admin.
    timeouts UserTimeoutsArgs
    user_id str
    email String
    The email for the user to invite.
    firstName String
    The name of the user.
    lastName String
    The last name of the user.
    systemRole String
    The privileges for the user. It can be either "ROLE_USER" or "ROLE_CUSTOMER". If set to "ROLE_CUSTOMER", the user will be known as an admin.
    timeouts Property Map
    userId String

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Version double
    Id string
    The provider-assigned unique ID for this managed resource.
    Version float64
    id String
    The provider-assigned unique ID for this managed resource.
    version Double
    id string
    The provider-assigned unique ID for this managed resource.
    version number
    id str
    The provider-assigned unique ID for this managed resource.
    version float
    id String
    The provider-assigned unique ID for this managed resource.
    version Number

    Look up Existing User Resource

    Get an existing User 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?: UserState, opts?: CustomResourceOptions): User
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            email: Optional[str] = None,
            first_name: Optional[str] = None,
            last_name: Optional[str] = None,
            system_role: Optional[str] = None,
            timeouts: Optional[UserTimeoutsArgs] = None,
            user_id: Optional[str] = None,
            version: Optional[float] = None) -> User
    func GetUser(ctx *Context, name string, id IDInput, state *UserState, opts ...ResourceOption) (*User, error)
    public static User Get(string name, Input<string> id, UserState? state, CustomResourceOptions? opts = null)
    public static User get(String name, Output<String> id, UserState state, CustomResourceOptions options)
    resources:  _:    type: sysdig:User    get:      id: ${id}
    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:
    Email string
    The email for the user to invite.
    FirstName string
    The name of the user.
    LastName string
    The last name of the user.
    SystemRole string
    The privileges for the user. It can be either "ROLE_USER" or "ROLE_CUSTOMER". If set to "ROLE_CUSTOMER", the user will be known as an admin.
    Timeouts UserTimeouts
    UserId string
    Version double
    Email string
    The email for the user to invite.
    FirstName string
    The name of the user.
    LastName string
    The last name of the user.
    SystemRole string
    The privileges for the user. It can be either "ROLE_USER" or "ROLE_CUSTOMER". If set to "ROLE_CUSTOMER", the user will be known as an admin.
    Timeouts UserTimeoutsArgs
    UserId string
    Version float64
    email String
    The email for the user to invite.
    firstName String
    The name of the user.
    lastName String
    The last name of the user.
    systemRole String
    The privileges for the user. It can be either "ROLE_USER" or "ROLE_CUSTOMER". If set to "ROLE_CUSTOMER", the user will be known as an admin.
    timeouts UserTimeouts
    userId String
    version Double
    email string
    The email for the user to invite.
    firstName string
    The name of the user.
    lastName string
    The last name of the user.
    systemRole string
    The privileges for the user. It can be either "ROLE_USER" or "ROLE_CUSTOMER". If set to "ROLE_CUSTOMER", the user will be known as an admin.
    timeouts UserTimeouts
    userId string
    version number
    email str
    The email for the user to invite.
    first_name str
    The name of the user.
    last_name str
    The last name of the user.
    system_role str
    The privileges for the user. It can be either "ROLE_USER" or "ROLE_CUSTOMER". If set to "ROLE_CUSTOMER", the user will be known as an admin.
    timeouts UserTimeoutsArgs
    user_id str
    version float
    email String
    The email for the user to invite.
    firstName String
    The name of the user.
    lastName String
    The last name of the user.
    systemRole String
    The privileges for the user. It can be either "ROLE_USER" or "ROLE_CUSTOMER". If set to "ROLE_CUSTOMER", the user will be known as an admin.
    timeouts Property Map
    userId String
    version Number

    Supporting Types

    UserTimeouts, UserTimeoutsArgs

    Create string
    Create string
    create String
    create string
    create str
    create String

    Import

    Sysdig users can be imported using the ID, e.g.

    $ pulumi import sysdig:index/user:User example 12345
    

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

    Package Details

    Repository
    sysdig sysdiglabs/terraform-provider-sysdig
    License
    Notes
    This Pulumi package is based on the sysdig Terraform Provider.
    sysdig logo
    sysdig 1.56.0 published on Wednesday, Apr 30, 2025 by sysdiglabs