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

coralogix.Group

Explore with Pulumi AI

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

    Coralogix group.

    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.User;
    import com.pulumi.coralogix.UserArgs;
    import com.pulumi.coralogix.inputs.UserNameArgs;
    import com.pulumi.coralogix.Scope;
    import com.pulumi.coralogix.ScopeArgs;
    import com.pulumi.coralogix.inputs.ScopeFilterArgs;
    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 exampleUser = new User("exampleUser", UserArgs.builder()
                .userName("example@coralogix.com")
                .name(UserNameArgs.builder()
                    .given_name("example")
                    .family_name("example")
                    .build())
                .build());
    
            var exampleScope = new Scope("exampleScope", ScopeArgs.builder()
                .displayName("ExampleScope")
                .defaultExpression("<v1>true")
                .filters(ScopeFilterArgs.builder()
                    .entityType("logs")
                    .expression("<v1>(subsystemName == 'purchases') || (subsystemName == 'signups')")
                    .build())
                .build());
    
            var exampleGroup = new Group("exampleGroup", GroupArgs.builder()
                .displayName("example")
                .role("Read Only")
                .members(exampleUser.id())
                .scopeId(exampleScope.id())
                .build());
    
        }
    }
    
    resources:
      exampleUser:
        type: coralogix:User
        properties:
          userName: example@coralogix.com
          name:
            given_name: example
            family_name: example
      exampleScope:
        type: coralogix:Scope
        properties:
          displayName: ExampleScope
          defaultExpression: <v1>true
          filters:
            - entityType: logs
              expression: <v1>(subsystemName == 'purchases') || (subsystemName == 'signups')
      exampleGroup:
        type: coralogix:Group
        properties:
          displayName: example
          role: Read Only
          members:
            - ${exampleUser.id}
          scopeId: ${exampleScope.id}
    

    Create Group Resource

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

    Constructor syntax

    new Group(name: string, args: GroupArgs, opts?: CustomResourceOptions);
    @overload
    def Group(resource_name: str,
              args: GroupArgs,
              opts: Optional[ResourceOptions] = None)
    
    @overload
    def Group(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              display_name: Optional[str] = None,
              role: Optional[str] = None,
              members: Optional[Sequence[str]] = None,
              scope_id: Optional[str] = None)
    func NewGroup(ctx *Context, name string, args GroupArgs, opts ...ResourceOption) (*Group, error)
    public Group(string name, GroupArgs args, CustomResourceOptions? opts = null)
    public Group(String name, GroupArgs args)
    public Group(String name, GroupArgs args, CustomResourceOptions options)
    
    type: coralogix:Group
    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 GroupArgs
    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 GroupArgs
    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 GroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GroupArgs
    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 groupResource = new Coralogix.Group("groupResource", new()
    {
        DisplayName = "string",
        Role = "string",
        Members = new[]
        {
            "string",
        },
        ScopeId = "string",
    });
    
    example, err := coralogix.NewGroup(ctx, "groupResource", &coralogix.GroupArgs{
    	DisplayName: pulumi.String("string"),
    	Role:        pulumi.String("string"),
    	Members: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	ScopeId: pulumi.String("string"),
    })
    
    var groupResource = new Group("groupResource", GroupArgs.builder()
        .displayName("string")
        .role("string")
        .members("string")
        .scopeId("string")
        .build());
    
    group_resource = coralogix.Group("groupResource",
        display_name="string",
        role="string",
        members=["string"],
        scope_id="string")
    
    const groupResource = new coralogix.Group("groupResource", {
        displayName: "string",
        role: "string",
        members: ["string"],
        scopeId: "string",
    });
    
    type: coralogix:Group
    properties:
        displayName: string
        members:
            - string
        role: string
        scopeId: string
    

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

    DisplayName string
    Group display name.
    Role string
    Members List<string>
    ScopeId string
    Scope attached to the group.
    DisplayName string
    Group display name.
    Role string
    Members []string
    ScopeId string
    Scope attached to the group.
    displayName String
    Group display name.
    role String
    members List<String>
    scopeId String
    Scope attached to the group.
    displayName string
    Group display name.
    role string
    members string[]
    scopeId string
    Scope attached to the group.
    display_name str
    Group display name.
    role str
    members Sequence[str]
    scope_id str
    Scope attached to the group.
    displayName String
    Group display name.
    role String
    members List<String>
    scopeId String
    Scope attached to the group.

    Outputs

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

    Get an existing Group 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?: GroupState, opts?: CustomResourceOptions): Group
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            display_name: Optional[str] = None,
            members: Optional[Sequence[str]] = None,
            role: Optional[str] = None,
            scope_id: Optional[str] = None) -> Group
    func GetGroup(ctx *Context, name string, id IDInput, state *GroupState, opts ...ResourceOption) (*Group, error)
    public static Group Get(string name, Input<string> id, GroupState? state, CustomResourceOptions? opts = null)
    public static Group get(String name, Output<String> id, GroupState state, CustomResourceOptions options)
    resources:  _:    type: coralogix:Group    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:
    DisplayName string
    Group display name.
    Members List<string>
    Role string
    ScopeId string
    Scope attached to the group.
    DisplayName string
    Group display name.
    Members []string
    Role string
    ScopeId string
    Scope attached to the group.
    displayName String
    Group display name.
    members List<String>
    role String
    scopeId String
    Scope attached to the group.
    displayName string
    Group display name.
    members string[]
    role string
    scopeId string
    Scope attached to the group.
    display_name str
    Group display name.
    members Sequence[str]
    role str
    scope_id str
    Scope attached to the group.
    displayName String
    Group display name.
    members List<String>
    role String
    scopeId String
    Scope attached to the group.

    Package Details

    Repository
    coralogix coralogix/terraform-provider-coralogix
    License
    Notes
    This Pulumi package is based on the coralogix Terraform Provider.
    coralogix logo
    coralogix 2.0.17 published on Tuesday, Apr 22, 2025 by coralogix