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

checkpoint.ManagementGroup

Explore with Pulumi AI

checkpoint logo
checkpoint 2.9.0 published on Monday, Apr 14, 2025 by checkpointsw

    This resource allows you to add/update/delete Check Point Group.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as checkpoint from "@pulumi/checkpoint";
    
    const example = new checkpoint.ManagementGroup("example", {members: [
        "New Host 1",
        "My Test Host 3",
    ]});
    
    import pulumi
    import pulumi_checkpoint as checkpoint
    
    example = checkpoint.ManagementGroup("example", members=[
        "New Host 1",
        "My Test Host 3",
    ])
    
    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.NewManagementGroup(ctx, "example", &checkpoint.ManagementGroupArgs{
    			Members: pulumi.StringArray{
    				pulumi.String("New Host 1"),
    				pulumi.String("My Test Host 3"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Checkpoint = Pulumi.Checkpoint;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Checkpoint.ManagementGroup("example", new()
        {
            Members = new[]
            {
                "New Host 1",
                "My Test Host 3",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.checkpoint.ManagementGroup;
    import com.pulumi.checkpoint.ManagementGroupArgs;
    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 ManagementGroup("example", ManagementGroupArgs.builder()
                .members(            
                    "New Host 1",
                    "My Test Host 3")
                .build());
    
        }
    }
    
    resources:
      example:
        type: checkpoint:ManagementGroup
        properties:
          members:
            - New Host 1
            - My Test Host 3
    

    Create ManagementGroup Resource

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

    Constructor syntax

    new ManagementGroup(name: string, args?: ManagementGroupArgs, opts?: CustomResourceOptions);
    @overload
    def ManagementGroup(resource_name: str,
                        args: Optional[ManagementGroupArgs] = None,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def ManagementGroup(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        color: Optional[str] = None,
                        comments: Optional[str] = None,
                        ignore_errors: Optional[bool] = None,
                        ignore_warnings: Optional[bool] = None,
                        management_group_id: Optional[str] = None,
                        members: Optional[Sequence[str]] = None,
                        name: Optional[str] = None,
                        tags: Optional[Sequence[str]] = None)
    func NewManagementGroup(ctx *Context, name string, args *ManagementGroupArgs, opts ...ResourceOption) (*ManagementGroup, error)
    public ManagementGroup(string name, ManagementGroupArgs? args = null, CustomResourceOptions? opts = null)
    public ManagementGroup(String name, ManagementGroupArgs args)
    public ManagementGroup(String name, ManagementGroupArgs args, CustomResourceOptions options)
    
    type: checkpoint:ManagementGroup
    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 ManagementGroupArgs
    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 ManagementGroupArgs
    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 ManagementGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ManagementGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ManagementGroupArgs
    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 managementGroupResource = new Checkpoint.ManagementGroup("managementGroupResource", new()
    {
        Color = "string",
        Comments = "string",
        IgnoreErrors = false,
        IgnoreWarnings = false,
        ManagementGroupId = "string",
        Members = new[]
        {
            "string",
        },
        Name = "string",
        Tags = new[]
        {
            "string",
        },
    });
    
    example, err := checkpoint.NewManagementGroup(ctx, "managementGroupResource", &checkpoint.ManagementGroupArgs{
    	Color:             pulumi.String("string"),
    	Comments:          pulumi.String("string"),
    	IgnoreErrors:      pulumi.Bool(false),
    	IgnoreWarnings:    pulumi.Bool(false),
    	ManagementGroupId: pulumi.String("string"),
    	Members: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Name: pulumi.String("string"),
    	Tags: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    var managementGroupResource = new ManagementGroup("managementGroupResource", ManagementGroupArgs.builder()
        .color("string")
        .comments("string")
        .ignoreErrors(false)
        .ignoreWarnings(false)
        .managementGroupId("string")
        .members("string")
        .name("string")
        .tags("string")
        .build());
    
    management_group_resource = checkpoint.ManagementGroup("managementGroupResource",
        color="string",
        comments="string",
        ignore_errors=False,
        ignore_warnings=False,
        management_group_id="string",
        members=["string"],
        name="string",
        tags=["string"])
    
    const managementGroupResource = new checkpoint.ManagementGroup("managementGroupResource", {
        color: "string",
        comments: "string",
        ignoreErrors: false,
        ignoreWarnings: false,
        managementGroupId: "string",
        members: ["string"],
        name: "string",
        tags: ["string"],
    });
    
    type: checkpoint:ManagementGroup
    properties:
        color: string
        comments: string
        ignoreErrors: false
        ignoreWarnings: false
        managementGroupId: string
        members:
            - string
        name: string
        tags:
            - string
    

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

    Color string
    Color of the object. Should be one of existing colors.
    Comments string
    Comments string.
    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.
    ManagementGroupId string
    Members List<string>
    Collection of Network objects identified by the name or UID.
    Name string
    Object name. Should be unique in the domain.
    Tags List<string>
    Collection of tag identifiers.
    Color string
    Color of the object. Should be one of existing colors.
    Comments string
    Comments string.
    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.
    ManagementGroupId string
    Members []string
    Collection of Network objects identified by the name or UID.
    Name string
    Object name. Should be unique in the domain.
    Tags []string
    Collection of tag identifiers.
    color String
    Color of the object. Should be one of existing colors.
    comments String
    Comments string.
    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.
    managementGroupId String
    members List<String>
    Collection of Network objects identified by the name or UID.
    name String
    Object name. Should be unique in the domain.
    tags List<String>
    Collection of tag identifiers.
    color string
    Color of the object. Should be one of existing colors.
    comments string
    Comments string.
    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.
    managementGroupId string
    members string[]
    Collection of Network objects identified by the name or UID.
    name string
    Object name. Should be unique in the domain.
    tags string[]
    Collection of tag identifiers.
    color str
    Color of the object. Should be one of existing colors.
    comments str
    Comments string.
    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_group_id str
    members Sequence[str]
    Collection of Network objects identified by the name or UID.
    name str
    Object name. Should be unique in the domain.
    tags Sequence[str]
    Collection of tag identifiers.
    color String
    Color of the object. Should be one of existing colors.
    comments String
    Comments string.
    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.
    managementGroupId String
    members List<String>
    Collection of Network objects identified by the name or UID.
    name String
    Object name. Should be unique in the domain.
    tags List<String>
    Collection of tag identifiers.

    Outputs

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

    Get an existing ManagementGroup 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?: ManagementGroupState, opts?: CustomResourceOptions): ManagementGroup
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            color: Optional[str] = None,
            comments: Optional[str] = None,
            ignore_errors: Optional[bool] = None,
            ignore_warnings: Optional[bool] = None,
            management_group_id: Optional[str] = None,
            members: Optional[Sequence[str]] = None,
            name: Optional[str] = None,
            tags: Optional[Sequence[str]] = None) -> ManagementGroup
    func GetManagementGroup(ctx *Context, name string, id IDInput, state *ManagementGroupState, opts ...ResourceOption) (*ManagementGroup, error)
    public static ManagementGroup Get(string name, Input<string> id, ManagementGroupState? state, CustomResourceOptions? opts = null)
    public static ManagementGroup get(String name, Output<String> id, ManagementGroupState state, CustomResourceOptions options)
    resources:  _:    type: checkpoint:ManagementGroup    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:
    Color string
    Color of the object. Should be one of existing colors.
    Comments string
    Comments string.
    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.
    ManagementGroupId string
    Members List<string>
    Collection of Network objects identified by the name or UID.
    Name string
    Object name. Should be unique in the domain.
    Tags List<string>
    Collection of tag identifiers.
    Color string
    Color of the object. Should be one of existing colors.
    Comments string
    Comments string.
    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.
    ManagementGroupId string
    Members []string
    Collection of Network objects identified by the name or UID.
    Name string
    Object name. Should be unique in the domain.
    Tags []string
    Collection of tag identifiers.
    color String
    Color of the object. Should be one of existing colors.
    comments String
    Comments string.
    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.
    managementGroupId String
    members List<String>
    Collection of Network objects identified by the name or UID.
    name String
    Object name. Should be unique in the domain.
    tags List<String>
    Collection of tag identifiers.
    color string
    Color of the object. Should be one of existing colors.
    comments string
    Comments string.
    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.
    managementGroupId string
    members string[]
    Collection of Network objects identified by the name or UID.
    name string
    Object name. Should be unique in the domain.
    tags string[]
    Collection of tag identifiers.
    color str
    Color of the object. Should be one of existing colors.
    comments str
    Comments string.
    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_group_id str
    members Sequence[str]
    Collection of Network objects identified by the name or UID.
    name str
    Object name. Should be unique in the domain.
    tags Sequence[str]
    Collection of tag identifiers.
    color String
    Color of the object. Should be one of existing colors.
    comments String
    Comments string.
    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.
    managementGroupId String
    members List<String>
    Collection of Network objects identified by the name or UID.
    name String
    Object name. Should be unique in the domain.
    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.
    checkpoint logo
    checkpoint 2.9.0 published on Monday, Apr 14, 2025 by checkpointsw