1. Packages
  2. Checkpoint Provider
  3. API Docs
  4. ManagementUserGroup
checkpoint 2.9.0 published on Monday, Apr 14, 2025 by checkpointsw

checkpoint.ManagementUserGroup

Explore with Pulumi AI

This resource allows you to execute Check Point User Group.

Example Usage

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

const example = new checkpoint.ManagementUserGroup("example", {email: "myusergroup@email.com"});
Copy
import pulumi
import pulumi_checkpoint as checkpoint

example = checkpoint.ManagementUserGroup("example", email="myusergroup@email.com")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := checkpoint.NewManagementUserGroup(ctx, "example", &checkpoint.ManagementUserGroupArgs{
			Email: pulumi.String("myusergroup@email.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Checkpoint = Pulumi.Checkpoint;

return await Deployment.RunAsync(() => 
{
    var example = new Checkpoint.ManagementUserGroup("example", new()
    {
        Email = "myusergroup@email.com",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.checkpoint.ManagementUserGroup;
import com.pulumi.checkpoint.ManagementUserGroupArgs;
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 example = new ManagementUserGroup("example", ManagementUserGroupArgs.builder()
            .email("myusergroup@email.com")
            .build());

    }
}
Copy
resources:
  example:
    type: checkpoint:ManagementUserGroup
    properties:
      email: myusergroup@email.com
Copy

Create ManagementUserGroup Resource

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

Constructor syntax

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

@overload
def ManagementUserGroup(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        color: Optional[str] = None,
                        comments: Optional[str] = None,
                        email: Optional[str] = None,
                        ignore_errors: Optional[bool] = None,
                        ignore_warnings: Optional[bool] = None,
                        management_user_group_id: Optional[str] = None,
                        members: Optional[Sequence[str]] = None,
                        name: Optional[str] = None,
                        tags: Optional[Sequence[str]] = None)
func NewManagementUserGroup(ctx *Context, name string, args *ManagementUserGroupArgs, opts ...ResourceOption) (*ManagementUserGroup, error)
public ManagementUserGroup(string name, ManagementUserGroupArgs? args = null, CustomResourceOptions? opts = null)
public ManagementUserGroup(String name, ManagementUserGroupArgs args)
public ManagementUserGroup(String name, ManagementUserGroupArgs args, CustomResourceOptions options)
type: checkpoint:ManagementUserGroup
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 ManagementUserGroupArgs
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 ManagementUserGroupArgs
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 ManagementUserGroupArgs
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 ManagementUserGroupArgs
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. ManagementUserGroupArgs
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 managementUserGroupResource = new Checkpoint.ManagementUserGroup("managementUserGroupResource", new()
{
    Color = "string",
    Comments = "string",
    Email = "string",
    IgnoreErrors = false,
    IgnoreWarnings = false,
    ManagementUserGroupId = "string",
    Members = new[]
    {
        "string",
    },
    Name = "string",
    Tags = new[]
    {
        "string",
    },
});
Copy
example, err := checkpoint.NewManagementUserGroup(ctx, "managementUserGroupResource", &checkpoint.ManagementUserGroupArgs{
Color: pulumi.String("string"),
Comments: pulumi.String("string"),
Email: pulumi.String("string"),
IgnoreErrors: pulumi.Bool(false),
IgnoreWarnings: pulumi.Bool(false),
ManagementUserGroupId: pulumi.String("string"),
Members: pulumi.StringArray{
pulumi.String("string"),
},
Name: pulumi.String("string"),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
})
Copy
var managementUserGroupResource = new ManagementUserGroup("managementUserGroupResource", ManagementUserGroupArgs.builder()
    .color("string")
    .comments("string")
    .email("string")
    .ignoreErrors(false)
    .ignoreWarnings(false)
    .managementUserGroupId("string")
    .members("string")
    .name("string")
    .tags("string")
    .build());
Copy
management_user_group_resource = checkpoint.ManagementUserGroup("managementUserGroupResource",
    color="string",
    comments="string",
    email="string",
    ignore_errors=False,
    ignore_warnings=False,
    management_user_group_id="string",
    members=["string"],
    name="string",
    tags=["string"])
Copy
const managementUserGroupResource = new checkpoint.ManagementUserGroup("managementUserGroupResource", {
    color: "string",
    comments: "string",
    email: "string",
    ignoreErrors: false,
    ignoreWarnings: false,
    managementUserGroupId: "string",
    members: ["string"],
    name: "string",
    tags: ["string"],
});
Copy
type: checkpoint:ManagementUserGroup
properties:
    color: string
    comments: string
    email: string
    ignoreErrors: false
    ignoreWarnings: false
    managementUserGroupId: string
    members:
        - string
    name: string
    tags:
        - string
Copy

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

Color string
Color of the object.
Comments string
Comments string.
Email string
Email Address.
IgnoreErrors bool
Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.
IgnoreWarnings bool
Apply changes ignoring warnings.
ManagementUserGroupId string
Members List<string>
Collection of User Group objects identified by the name or UID.
Name string
Object name.
Tags List<string>
Collection of tag identifiers.
Color string
Color of the object.
Comments string
Comments string.
Email string
Email Address.
IgnoreErrors bool
Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.
IgnoreWarnings bool
Apply changes ignoring warnings.
ManagementUserGroupId string
Members []string
Collection of User Group objects identified by the name or UID.
Name string
Object name.
Tags []string
Collection of tag identifiers.
color String
Color of the object.
comments String
Comments string.
email String
Email Address.
ignoreErrors Boolean
Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.
ignoreWarnings Boolean
Apply changes ignoring warnings.
managementUserGroupId String
members List<String>
Collection of User Group objects identified by the name or UID.
name String
Object name.
tags List<String>
Collection of tag identifiers.
color string
Color of the object.
comments string
Comments string.
email string
Email Address.
ignoreErrors boolean
Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.
ignoreWarnings boolean
Apply changes ignoring warnings.
managementUserGroupId string
members string[]
Collection of User Group objects identified by the name or UID.
name string
Object name.
tags string[]
Collection of tag identifiers.
color str
Color of the object.
comments str
Comments string.
email str
Email Address.
ignore_errors bool
Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.
ignore_warnings bool
Apply changes ignoring warnings.
management_user_group_id str
members Sequence[str]
Collection of User Group objects identified by the name or UID.
name str
Object name.
tags Sequence[str]
Collection of tag identifiers.
color String
Color of the object.
comments String
Comments string.
email String
Email Address.
ignoreErrors Boolean
Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.
ignoreWarnings Boolean
Apply changes ignoring warnings.
managementUserGroupId String
members List<String>
Collection of User Group objects identified by the name or UID.
name String
Object name.
tags List<String>
Collection of tag identifiers.

Outputs

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

Get an existing ManagementUserGroup 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?: ManagementUserGroupState, opts?: CustomResourceOptions): ManagementUserGroup
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        color: Optional[str] = None,
        comments: Optional[str] = None,
        email: Optional[str] = None,
        ignore_errors: Optional[bool] = None,
        ignore_warnings: Optional[bool] = None,
        management_user_group_id: Optional[str] = None,
        members: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        tags: Optional[Sequence[str]] = None) -> ManagementUserGroup
func GetManagementUserGroup(ctx *Context, name string, id IDInput, state *ManagementUserGroupState, opts ...ResourceOption) (*ManagementUserGroup, error)
public static ManagementUserGroup Get(string name, Input<string> id, ManagementUserGroupState? state, CustomResourceOptions? opts = null)
public static ManagementUserGroup get(String name, Output<String> id, ManagementUserGroupState state, CustomResourceOptions options)
resources:  _:    type: checkpoint:ManagementUserGroup    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:
Color string
Color of the object.
Comments string
Comments string.
Email string
Email Address.
IgnoreErrors bool
Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.
IgnoreWarnings bool
Apply changes ignoring warnings.
ManagementUserGroupId string
Members List<string>
Collection of User Group objects identified by the name or UID.
Name string
Object name.
Tags List<string>
Collection of tag identifiers.
Color string
Color of the object.
Comments string
Comments string.
Email string
Email Address.
IgnoreErrors bool
Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.
IgnoreWarnings bool
Apply changes ignoring warnings.
ManagementUserGroupId string
Members []string
Collection of User Group objects identified by the name or UID.
Name string
Object name.
Tags []string
Collection of tag identifiers.
color String
Color of the object.
comments String
Comments string.
email String
Email Address.
ignoreErrors Boolean
Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.
ignoreWarnings Boolean
Apply changes ignoring warnings.
managementUserGroupId String
members List<String>
Collection of User Group objects identified by the name or UID.
name String
Object name.
tags List<String>
Collection of tag identifiers.
color string
Color of the object.
comments string
Comments string.
email string
Email Address.
ignoreErrors boolean
Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.
ignoreWarnings boolean
Apply changes ignoring warnings.
managementUserGroupId string
members string[]
Collection of User Group objects identified by the name or UID.
name string
Object name.
tags string[]
Collection of tag identifiers.
color str
Color of the object.
comments str
Comments string.
email str
Email Address.
ignore_errors bool
Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.
ignore_warnings bool
Apply changes ignoring warnings.
management_user_group_id str
members Sequence[str]
Collection of User Group objects identified by the name or UID.
name str
Object name.
tags Sequence[str]
Collection of tag identifiers.
color String
Color of the object.
comments String
Comments string.
email String
Email Address.
ignoreErrors Boolean
Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.
ignoreWarnings Boolean
Apply changes ignoring warnings.
managementUserGroupId String
members List<String>
Collection of User Group objects identified by the name or UID.
name String
Object name.
tags List<String>
Collection of tag identifiers.

Package Details

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