1. Packages
  2. Coralogix Provider
  3. API Docs
  4. CustomRole
coralogix 2.0.17 published on Tuesday, Apr 22, 2025 by coralogix

coralogix.CustomRole

Explore with Pulumi AI

Coralogix Custom Role.

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());

    }
}
Copy
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}
Copy

Create CustomRole Resource

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

Constructor syntax

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

@overload
def CustomRole(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               description: Optional[str] = None,
               parent_role: Optional[str] = None,
               permissions: Optional[Sequence[str]] = None,
               name: Optional[str] = None)
func NewCustomRole(ctx *Context, name string, args CustomRoleArgs, opts ...ResourceOption) (*CustomRole, error)
public CustomRole(string name, CustomRoleArgs args, CustomResourceOptions? opts = null)
public CustomRole(String name, CustomRoleArgs args)
public CustomRole(String name, CustomRoleArgs args, CustomResourceOptions options)
type: coralogix:CustomRole
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. CustomRoleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. CustomRoleArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. CustomRoleArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. CustomRoleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. CustomRoleArgs
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 customRoleResource = new Coralogix.CustomRole("customRoleResource", new()
{
    Description = "string",
    ParentRole = "string",
    Permissions = new[]
    {
        "string",
    },
    Name = "string",
});
Copy
example, err := coralogix.NewCustomRole(ctx, "customRoleResource", &coralogix.CustomRoleArgs{
	Description: pulumi.String("string"),
	ParentRole:  pulumi.String("string"),
	Permissions: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name: pulumi.String("string"),
})
Copy
var customRoleResource = new CustomRole("customRoleResource", CustomRoleArgs.builder()
    .description("string")
    .parentRole("string")
    .permissions("string")
    .name("string")
    .build());
Copy
custom_role_resource = coralogix.CustomRole("customRoleResource",
    description="string",
    parent_role="string",
    permissions=["string"],
    name="string")
Copy
const customRoleResource = new coralogix.CustomRole("customRoleResource", {
    description: "string",
    parentRole: "string",
    permissions: ["string"],
    name: "string",
});
Copy
type: coralogix:CustomRole
properties:
    description: string
    name: string
    parentRole: string
    permissions:
        - string
Copy

CustomRole 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 CustomRole resource accepts the following input properties:

Description This property is required. string
Custom Role description.
ParentRole This property is required. string
Parent role name
Permissions This property is required. List<string>
Custom role permissions
Name string
Custom Role name.
Description This property is required. string
Custom Role description.
ParentRole This property is required. string
Parent role name
Permissions This property is required. []string
Custom role permissions
Name string
Custom Role name.
description This property is required. String
Custom Role description.
parentRole This property is required. String
Parent role name
permissions This property is required. List<String>
Custom role permissions
name String
Custom Role name.
description This property is required. string
Custom Role description.
parentRole This property is required. string
Parent role name
permissions This property is required. string[]
Custom role permissions
name string
Custom Role name.
description This property is required. str
Custom Role description.
parent_role This property is required. str
Parent role name
permissions This property is required. Sequence[str]
Custom role permissions
name str
Custom Role name.
description This property is required. String
Custom Role description.
parentRole This property is required. String
Parent role name
permissions This property is required. List<String>
Custom role permissions
name String
Custom Role name.

Outputs

All input properties are implicitly available as output properties. Additionally, the CustomRole 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 CustomRole Resource

Get an existing CustomRole 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?: CustomRoleState, opts?: CustomResourceOptions): CustomRole
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        parent_role: Optional[str] = None,
        permissions: Optional[Sequence[str]] = None) -> CustomRole
func GetCustomRole(ctx *Context, name string, id IDInput, state *CustomRoleState, opts ...ResourceOption) (*CustomRole, error)
public static CustomRole Get(string name, Input<string> id, CustomRoleState? state, CustomResourceOptions? opts = null)
public static CustomRole get(String name, Output<String> id, CustomRoleState state, CustomResourceOptions options)
resources:  _:    type: coralogix:CustomRole    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Description string
Custom Role description.
Name string
Custom Role name.
ParentRole string
Parent role name
Permissions List<string>
Custom role permissions
Description string
Custom Role description.
Name string
Custom Role name.
ParentRole string
Parent role name
Permissions []string
Custom role permissions
description String
Custom Role description.
name String
Custom Role name.
parentRole String
Parent role name
permissions List<String>
Custom role permissions
description string
Custom Role description.
name string
Custom Role name.
parentRole string
Parent role name
permissions string[]
Custom role permissions
description str
Custom Role description.
name str
Custom Role name.
parent_role str
Parent role name
permissions Sequence[str]
Custom role permissions
description String
Custom Role description.
name String
Custom Role name.
parentRole String
Parent role name
permissions List<String>
Custom role permissions

Package Details

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