coralogix 2.0.17, Apr 22 25

coralogix 2.0.17 published on Tuesday, Apr 22, 2025 by coralogix

coralogix.User

Explore with Pulumi AI

coralogix 2.0.17 published on Tuesday, Apr 22, 2025 by coralogix

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.coralogix.CustomRole;
import com.pulumi.coralogix.CustomRoleArgs;
import com.pulumi.coralogix.User;
import com.pulumi.coralogix.UserArgs;
import com.pulumi.coralogix.inputs.UserNameArgs;
import com.pulumi.coralogix.Group;
import com.pulumi.coralogix.GroupArgs;
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 exampleCustomRole = new CustomRole("exampleCustomRole", CustomRoleArgs.builder()
            .description("This role is created with terraform!")
            .parentRole("Standard User")
            .permissions("spans.events2metrics:UpdateConfig")
            .build());

        var exampleUser = new User("exampleUser", UserArgs.builder()
            .userName("example@coralogix.com")
            .name(UserNameArgs.builder()
                .given_name("example")
                .family_name("example")
                .build())
            .build());

        var exampleGroup = new Group("exampleGroup", GroupArgs.builder()
            .displayName("example")
            .role(exampleCustomRole.name())
            .members(exampleUser.id())
            .build());

    }
}

resources:
  exampleCustomRole:
    type: coralogix:CustomRole
    properties:
      description: This role is created with terraform!
      parentRole: Standard User
      permissions:
        - spans.events2metrics:UpdateConfig
  exampleUser:
    type: coralogix:User
    properties:
      userName: example@coralogix.com
      name:
        given_name: example
        family_name: example
  exampleGroup:
    type: coralogix:Group
    properties:
      displayName: example
      role: ${exampleCustomRole.name}
      members:
        - ${exampleUser.id}

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,
         user_name: Optional[str] = None,
         active: Optional[bool] = None,
         name: Optional[UserNameArgs] = 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: coralogix: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 Coralogix.User("userResource", new()
{
    UserName = "string",
    Active = false,
    Name = new Coralogix.Inputs.UserNameArgs
    {
        FamilyName = "string",
        GivenName = "string",
    },
});

example, err := coralogix.NewUser(ctx, "userResource", &coralogix.UserArgs{
	UserName: pulumi.String("string"),
	Active:   pulumi.Bool(false),
	Name: &coralogix.UserNameArgs{
		FamilyName: pulumi.String("string"),
		GivenName:  pulumi.String("string"),
	},
})

var userResource = new User("userResource", UserArgs.builder()
    .userName("string")
    .active(false)
    .name(UserNameArgs.builder()
        .familyName("string")
        .givenName("string")
        .build())
    .build());

user_resource = coralogix.User("userResource",
    user_name="string",
    active=False,
    name={
        "family_name": "string",
        "given_name": "string",
    })

const userResource = new coralogix.User("userResource", {
    userName: "string",
    active: false,
    name: {
        familyName: "string",
        givenName: "string",
    },
});

type: coralogix:User
properties:
    active: false
    name:
        familyName: string
        givenName: string
    userName: 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:

UserName string: User name.
Active bool
Name UserName

UserName string: User name.
Active bool
Name UserNameArgs

userName String: User name.
active Boolean
name UserName

userName string: User name.
active boolean
name UserName

user_name str: User name.
active bool
name UserNameArgs

userName String: User name.
active Boolean
name Property Map

Outputs

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

Emails List<UserEmail>
Groups List<string>
Id string: The provider-assigned unique ID for this managed resource.

Emails []UserEmail
Groups []string
Id string: The provider-assigned unique ID for this managed resource.

emails List<UserEmail>
groups List<String>
id String: The provider-assigned unique ID for this managed resource.

emails UserEmail[]
groups string[]
id string: The provider-assigned unique ID for this managed resource.

emails Sequence[UserEmail]
groups Sequence[str]
id str: The provider-assigned unique ID for this managed resource.

emails List<Property Map>
groups List<String>
id String: The provider-assigned unique ID for this managed resource.

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,
        active: Optional[bool] = None,
        emails: Optional[Sequence[UserEmailArgs]] = None,
        groups: Optional[Sequence[str]] = None,
        name: Optional[UserNameArgs] = None,
        user_name: Optional[str] = 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: coralogix: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:

Active bool
Emails List<UserEmail>
Groups List<string>
Name UserName
UserName string: User name.

Active bool
Emails []UserEmailArgs
Groups []string
Name UserNameArgs
UserName string: User name.

active Boolean
emails List<UserEmail>
groups List<String>
name UserName
userName String: User name.

active boolean
emails UserEmail[]
groups string[]
name UserName
userName string: User name.

active bool
emails Sequence[UserEmailArgs]
groups Sequence[str]
name UserNameArgs
user_name str: User name.

active Boolean
emails List<Property Map>
groups List<String>
name Property Map
userName String: User name.

Supporting Types

UserEmail, UserEmailArgs

Primary bool
Type string
Value string

Primary bool
Type string
Value string

primary Boolean
type String
value String

primary boolean
type string
value string

primary bool
type str
value str

primary Boolean
type String
value String

UserName, UserNameArgs

FamilyName string
GivenName string

FamilyName string
GivenName string

familyName String
givenName String

familyName string
givenName string

family_name str
given_name str

familyName String
givenName String

Package Details

Repository: coralogix coralogix/terraform-provider-coralogix
License
Notes: This Pulumi package is based on the coralogix Terraform Provider.

coralogix 2.0.17 published on Tuesday, Apr 22, 2025 by coralogix

coralogix/terraform-provider-coralogix

coralogix.User

On this page

On this page

Example Usage

Create User Resource

Constructor syntax

Parameters

Constructor example

User Resource Properties

Inputs

Outputs

Look up Existing User Resource

Supporting Types

UserEmail, UserEmailArgs

UserName, UserNameArgs

Package Details

On this page

On this page