Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Checkpoint Provider
  4. API Docs
  5. GaiaNatPool
Viewing docs for checkpoint 3.2.0
published on Monday, Jun 15, 2026 by checkpointsw
Schema (JSON)
checkpointsw/terraform-provider-checkpoint

checkpoint.GaiaNatPool

Viewing docs for checkpoint 3.2.0
published on Monday, Jun 15, 2026 by checkpointsw
Schema (JSON)
checkpointsw/terraform-provider-checkpoint

    This resource allows you to execute Check Point Nat Pool.

    Example Usage

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

const example = new checkpoint.GaiaNatPool("example", {
    prefix: "10.10.10.0/24",
    comment: "Test Comment",
});

    import pulumi
import pulumi_checkpoint as checkpoint

example = checkpoint.GaiaNatPool("example",
    prefix="10.10.10.0/24",
    comment="Test Comment")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := checkpoint.NewGaiaNatPool(ctx, "example", &checkpoint.GaiaNatPoolArgs{
			Prefix:  pulumi.String("10.10.10.0/24"),
			Comment: pulumi.String("Test Comment"),
		})
		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.GaiaNatPool("example", new()
    {
        Prefix = "10.10.10.0/24",
        Comment = "Test Comment",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.checkpoint.GaiaNatPool;
import com.pulumi.checkpoint.GaiaNatPoolArgs;
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 GaiaNatPool("example", GaiaNatPoolArgs.builder()
            .prefix("10.10.10.0/24")
            .comment("Test Comment")
            .build());

    }
}

    resources:
  example:
    type: checkpoint:GaiaNatPool
    properties:
      prefix: 10.10.10.0/24
      comment: Test Comment

    Example coming soon!

    Create GaiaNatPool Resource

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

    Constructor syntax

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

@overload
def GaiaNatPool(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                comment: Optional[str] = None,
                prefix: Optional[str] = None,
                debug: Optional[bool] = None,
                gaia_nat_pool_id: Optional[str] = None,
                member_id: Optional[str] = None)
    func NewGaiaNatPool(ctx *Context, name string, args GaiaNatPoolArgs, opts ...ResourceOption) (*GaiaNatPool, error)
    public GaiaNatPool(string name, GaiaNatPoolArgs args, CustomResourceOptions? opts = null)
    public GaiaNatPool(String name, GaiaNatPoolArgs args)
public GaiaNatPool(String name, GaiaNatPoolArgs args, CustomResourceOptions options)

    type: checkpoint:GaiaNatPool
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "checkpoint_gaianatpool" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args GaiaNatPoolArgs
    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 GaiaNatPoolArgs
    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 GaiaNatPoolArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GaiaNatPoolArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GaiaNatPoolArgs
    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 gaiaNatPoolResource = new Checkpoint.GaiaNatPool("gaiaNatPoolResource", new()
{
    Comment = "string",
    Prefix = "string",
    Debug = false,
    GaiaNatPoolId = "string",
    MemberId = "string",
});

    example, err := checkpoint.NewGaiaNatPool(ctx, "gaiaNatPoolResource", &checkpoint.GaiaNatPoolArgs{
	Comment:       pulumi.String("string"),
	Prefix:        pulumi.String("string"),
	Debug:         pulumi.Bool(false),
	GaiaNatPoolId: pulumi.String("string"),
	MemberId:      pulumi.String("string"),
})

    resource "checkpoint_gaianatpool" "gaiaNatPoolResource" {
  comment          = "string"
  prefix           = "string"
  debug            = false
  gaia_nat_pool_id = "string"
  member_id        = "string"
}

    var gaiaNatPoolResource = new GaiaNatPool("gaiaNatPoolResource", GaiaNatPoolArgs.builder()
    .comment("string")
    .prefix("string")
    .debug(false)
    .gaiaNatPoolId("string")
    .memberId("string")
    .build());

    gaia_nat_pool_resource = checkpoint.GaiaNatPool("gaiaNatPoolResource",
    comment="string",
    prefix="string",
    debug=False,
    gaia_nat_pool_id="string",
    member_id="string")

    const gaiaNatPoolResource = new checkpoint.GaiaNatPool("gaiaNatPoolResource", {
    comment: "string",
    prefix: "string",
    debug: false,
    gaiaNatPoolId: "string",
    memberId: "string",
});

    type: checkpoint:GaiaNatPool
properties:
    comment: string
    debug: false
    gaiaNatPoolId: string
    memberId: string
    prefix: string

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

    Comment string
    Specifies a comment on a NAT pool. If the empty string is given, no comments will be added to the NAT pool. Note: The length of the comment cannot exceed 100 characters
    Prefix string
    Specifies the IPv4 or IPv6 destination prefix of a NAT pool to be configured. Note: A prefix cannot be of type IPv6, if IPv6 capabilities are not enabled
    Debug bool
    Enable debug logging for this resource.
    GaiaNatPoolId string
    MemberId string
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    Comment string
    Specifies a comment on a NAT pool. If the empty string is given, no comments will be added to the NAT pool. Note: The length of the comment cannot exceed 100 characters
    Prefix string
    Specifies the IPv4 or IPv6 destination prefix of a NAT pool to be configured. Note: A prefix cannot be of type IPv6, if IPv6 capabilities are not enabled
    Debug bool
    Enable debug logging for this resource.
    GaiaNatPoolId string
    MemberId string
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    comment string
    Specifies a comment on a NAT pool. If the empty string is given, no comments will be added to the NAT pool. Note: The length of the comment cannot exceed 100 characters
    prefix string
    Specifies the IPv4 or IPv6 destination prefix of a NAT pool to be configured. Note: A prefix cannot be of type IPv6, if IPv6 capabilities are not enabled
    debug bool
    Enable debug logging for this resource.
    gaia_nat_pool_id string
    member_id string
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    comment String
    Specifies a comment on a NAT pool. If the empty string is given, no comments will be added to the NAT pool. Note: The length of the comment cannot exceed 100 characters
    prefix String
    Specifies the IPv4 or IPv6 destination prefix of a NAT pool to be configured. Note: A prefix cannot be of type IPv6, if IPv6 capabilities are not enabled
    debug Boolean
    Enable debug logging for this resource.
    gaiaNatPoolId String
    memberId String
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    comment string
    Specifies a comment on a NAT pool. If the empty string is given, no comments will be added to the NAT pool. Note: The length of the comment cannot exceed 100 characters
    prefix string
    Specifies the IPv4 or IPv6 destination prefix of a NAT pool to be configured. Note: A prefix cannot be of type IPv6, if IPv6 capabilities are not enabled
    debug boolean
    Enable debug logging for this resource.
    gaiaNatPoolId string
    memberId string
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    comment str
    Specifies a comment on a NAT pool. If the empty string is given, no comments will be added to the NAT pool. Note: The length of the comment cannot exceed 100 characters
    prefix str
    Specifies the IPv4 or IPv6 destination prefix of a NAT pool to be configured. Note: A prefix cannot be of type IPv6, if IPv6 capabilities are not enabled
    debug bool
    Enable debug logging for this resource.
    gaia_nat_pool_id str
    member_id str
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    comment String
    Specifies a comment on a NAT pool. If the empty string is given, no comments will be added to the NAT pool. Note: The length of the comment cannot exceed 100 characters
    prefix String
    Specifies the IPv4 or IPv6 destination prefix of a NAT pool to be configured. Note: A prefix cannot be of type IPv6, if IPv6 capabilities are not enabled
    debug Boolean
    Enable debug logging for this resource.
    gaiaNatPoolId String
    memberId String
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members

    Outputs

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

    Get an existing GaiaNatPool 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?: GaiaNatPoolState, opts?: CustomResourceOptions): GaiaNatPool
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        comment: Optional[str] = None,
        debug: Optional[bool] = None,
        gaia_nat_pool_id: Optional[str] = None,
        member_id: Optional[str] = None,
        prefix: Optional[str] = None) -> GaiaNatPool
    func GetGaiaNatPool(ctx *Context, name string, id IDInput, state *GaiaNatPoolState, opts ...ResourceOption) (*GaiaNatPool, error)
    public static GaiaNatPool Get(string name, Input<string> id, GaiaNatPoolState? state, CustomResourceOptions? opts = null)
    public static GaiaNatPool get(String name, Output<String> id, GaiaNatPoolState state, CustomResourceOptions options)
    resources:  _:    type: checkpoint:GaiaNatPool    get:      id: ${id}
    import {
  to = checkpoint_gaianatpool.example
  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:
    Comment string
    Specifies a comment on a NAT pool. If the empty string is given, no comments will be added to the NAT pool. Note: The length of the comment cannot exceed 100 characters
    Debug bool
    Enable debug logging for this resource.
    GaiaNatPoolId string
    MemberId string
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    Prefix string
    Specifies the IPv4 or IPv6 destination prefix of a NAT pool to be configured. Note: A prefix cannot be of type IPv6, if IPv6 capabilities are not enabled
    Comment string
    Specifies a comment on a NAT pool. If the empty string is given, no comments will be added to the NAT pool. Note: The length of the comment cannot exceed 100 characters
    Debug bool
    Enable debug logging for this resource.
    GaiaNatPoolId string
    MemberId string
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    Prefix string
    Specifies the IPv4 or IPv6 destination prefix of a NAT pool to be configured. Note: A prefix cannot be of type IPv6, if IPv6 capabilities are not enabled
    comment string
    Specifies a comment on a NAT pool. If the empty string is given, no comments will be added to the NAT pool. Note: The length of the comment cannot exceed 100 characters
    debug bool
    Enable debug logging for this resource.
    gaia_nat_pool_id string
    member_id string
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    prefix string
    Specifies the IPv4 or IPv6 destination prefix of a NAT pool to be configured. Note: A prefix cannot be of type IPv6, if IPv6 capabilities are not enabled
    comment String
    Specifies a comment on a NAT pool. If the empty string is given, no comments will be added to the NAT pool. Note: The length of the comment cannot exceed 100 characters
    debug Boolean
    Enable debug logging for this resource.
    gaiaNatPoolId String
    memberId String
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    prefix String
    Specifies the IPv4 or IPv6 destination prefix of a NAT pool to be configured. Note: A prefix cannot be of type IPv6, if IPv6 capabilities are not enabled
    comment string
    Specifies a comment on a NAT pool. If the empty string is given, no comments will be added to the NAT pool. Note: The length of the comment cannot exceed 100 characters
    debug boolean
    Enable debug logging for this resource.
    gaiaNatPoolId string
    memberId string
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    prefix string
    Specifies the IPv4 or IPv6 destination prefix of a NAT pool to be configured. Note: A prefix cannot be of type IPv6, if IPv6 capabilities are not enabled
    comment str
    Specifies a comment on a NAT pool. If the empty string is given, no comments will be added to the NAT pool. Note: The length of the comment cannot exceed 100 characters
    debug bool
    Enable debug logging for this resource.
    gaia_nat_pool_id str
    member_id str
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    prefix str
    Specifies the IPv4 or IPv6 destination prefix of a NAT pool to be configured. Note: A prefix cannot be of type IPv6, if IPv6 capabilities are not enabled
    comment String
    Specifies a comment on a NAT pool. If the empty string is given, no comments will be added to the NAT pool. Note: The length of the comment cannot exceed 100 characters
    debug Boolean
    Enable debug logging for this resource.
    gaiaNatPoolId String
    memberId String
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    prefix String
    Specifies the IPv4 or IPv6 destination prefix of a NAT pool to be configured. Note: A prefix cannot be of type IPv6, if IPv6 capabilities are not enabled

    Package Details

    Repository
    checkpoint checkpointsw/terraform-provider-checkpoint
    License
    Notes
    This Pulumi package is based on the checkpoint Terraform Provider.
    Viewing docs for checkpoint 3.2.0
    published on Monday, Jun 15, 2026 by checkpointsw
    Schema (JSON)
    checkpointsw/terraform-provider-checkpoint

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial