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

checkpoint.GaiaBanner

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 Banner.

    Example Usage

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

const example = new checkpoint.GaiaBanner("example", {
    enabled: true,
    message: "This is a new banner message",
});

    import pulumi
import pulumi_checkpoint as checkpoint

example = checkpoint.GaiaBanner("example",
    enabled=True,
    message="This is a new banner message")

    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.NewGaiaBanner(ctx, "example", &checkpoint.GaiaBannerArgs{
			Enabled: pulumi.Bool(true),
			Message: pulumi.String("This is a new banner message"),
		})
		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.GaiaBanner("example", new()
    {
        Enabled = true,
        Message = "This is a new banner message",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.checkpoint.GaiaBanner;
import com.pulumi.checkpoint.GaiaBannerArgs;
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 GaiaBanner("example", GaiaBannerArgs.builder()
            .enabled(true)
            .message("This is a new banner message")
            .build());

    }
}

    resources:
  example:
    type: checkpoint:GaiaBanner
    properties:
      enabled: true
      message: This is a new banner message

    Example coming soon!

    Create GaiaBanner Resource

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

    Constructor syntax

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

@overload
def GaiaBanner(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               debug: Optional[bool] = None,
               enabled: Optional[bool] = None,
               gaia_banner_id: Optional[str] = None,
               member_id: Optional[str] = None,
               message: Optional[str] = None)
    func NewGaiaBanner(ctx *Context, name string, args *GaiaBannerArgs, opts ...ResourceOption) (*GaiaBanner, error)
    public GaiaBanner(string name, GaiaBannerArgs? args = null, CustomResourceOptions? opts = null)
    public GaiaBanner(String name, GaiaBannerArgs args)
public GaiaBanner(String name, GaiaBannerArgs args, CustomResourceOptions options)

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


    resource "checkpoint_gaiabanner" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args GaiaBannerArgs
    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 GaiaBannerArgs
    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 GaiaBannerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GaiaBannerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GaiaBannerArgs
    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 gaiaBannerResource = new Checkpoint.GaiaBanner("gaiaBannerResource", new()
{
    Debug = false,
    Enabled = false,
    GaiaBannerId = "string",
    MemberId = "string",
    Message = "string",
});

    example, err := checkpoint.NewGaiaBanner(ctx, "gaiaBannerResource", &checkpoint.GaiaBannerArgs{
	Debug:        pulumi.Bool(false),
	Enabled:      pulumi.Bool(false),
	GaiaBannerId: pulumi.String("string"),
	MemberId:     pulumi.String("string"),
	Message:      pulumi.String("string"),
})

    resource "checkpoint_gaiabanner" "gaiaBannerResource" {
  debug          = false
  enabled        = false
  gaia_banner_id = "string"
  member_id      = "string"
  message        = "string"
}

    var gaiaBannerResource = new GaiaBanner("gaiaBannerResource", GaiaBannerArgs.builder()
    .debug(false)
    .enabled(false)
    .gaiaBannerId("string")
    .memberId("string")
    .message("string")
    .build());

    gaia_banner_resource = checkpoint.GaiaBanner("gaiaBannerResource",
    debug=False,
    enabled=False,
    gaia_banner_id="string",
    member_id="string",
    message="string")

    const gaiaBannerResource = new checkpoint.GaiaBanner("gaiaBannerResource", {
    debug: false,
    enabled: false,
    gaiaBannerId: "string",
    memberId: "string",
    message: "string",
});

    type: checkpoint:GaiaBanner
properties:
    debug: false
    enabled: false
    gaiaBannerId: string
    memberId: string
    message: string

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

    Debug bool
    Enable debug logging for this resource.
    Enabled bool
    Banner message enabled (true/false)
    GaiaBannerId 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
    Message string
    Banner message for the web, ssh and serial login. Empty string returns to default
    Debug bool
    Enable debug logging for this resource.
    Enabled bool
    Banner message enabled (true/false)
    GaiaBannerId 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
    Message string
    Banner message for the web, ssh and serial login. Empty string returns to default
    debug bool
    Enable debug logging for this resource.
    enabled bool
    Banner message enabled (true/false)
    gaia_banner_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
    message string
    Banner message for the web, ssh and serial login. Empty string returns to default
    debug Boolean
    Enable debug logging for this resource.
    enabled Boolean
    Banner message enabled (true/false)
    gaiaBannerId 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
    message String
    Banner message for the web, ssh and serial login. Empty string returns to default
    debug boolean
    Enable debug logging for this resource.
    enabled boolean
    Banner message enabled (true/false)
    gaiaBannerId 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
    message string
    Banner message for the web, ssh and serial login. Empty string returns to default
    debug bool
    Enable debug logging for this resource.
    enabled bool
    Banner message enabled (true/false)
    gaia_banner_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
    message str
    Banner message for the web, ssh and serial login. Empty string returns to default
    debug Boolean
    Enable debug logging for this resource.
    enabled Boolean
    Banner message enabled (true/false)
    gaiaBannerId 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
    message String
    Banner message for the web, ssh and serial login. Empty string returns to default

    Outputs

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

    Get an existing GaiaBanner 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?: GaiaBannerState, opts?: CustomResourceOptions): GaiaBanner
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        debug: Optional[bool] = None,
        enabled: Optional[bool] = None,
        gaia_banner_id: Optional[str] = None,
        member_id: Optional[str] = None,
        message: Optional[str] = None) -> GaiaBanner
    func GetGaiaBanner(ctx *Context, name string, id IDInput, state *GaiaBannerState, opts ...ResourceOption) (*GaiaBanner, error)
    public static GaiaBanner Get(string name, Input<string> id, GaiaBannerState? state, CustomResourceOptions? opts = null)
    public static GaiaBanner get(String name, Output<String> id, GaiaBannerState state, CustomResourceOptions options)
    resources:  _:    type: checkpoint:GaiaBanner    get:      id: ${id}
    import {
  to = checkpoint_gaiabanner.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:
    Debug bool
    Enable debug logging for this resource.
    Enabled bool
    Banner message enabled (true/false)
    GaiaBannerId 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
    Message string
    Banner message for the web, ssh and serial login. Empty string returns to default
    Debug bool
    Enable debug logging for this resource.
    Enabled bool
    Banner message enabled (true/false)
    GaiaBannerId 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
    Message string
    Banner message for the web, ssh and serial login. Empty string returns to default
    debug bool
    Enable debug logging for this resource.
    enabled bool
    Banner message enabled (true/false)
    gaia_banner_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
    message string
    Banner message for the web, ssh and serial login. Empty string returns to default
    debug Boolean
    Enable debug logging for this resource.
    enabled Boolean
    Banner message enabled (true/false)
    gaiaBannerId 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
    message String
    Banner message for the web, ssh and serial login. Empty string returns to default
    debug boolean
    Enable debug logging for this resource.
    enabled boolean
    Banner message enabled (true/false)
    gaiaBannerId 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
    message string
    Banner message for the web, ssh and serial login. Empty string returns to default
    debug bool
    Enable debug logging for this resource.
    enabled bool
    Banner message enabled (true/false)
    gaia_banner_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
    message str
    Banner message for the web, ssh and serial login. Empty string returns to default
    debug Boolean
    Enable debug logging for this resource.
    enabled Boolean
    Banner message enabled (true/false)
    gaiaBannerId 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
    message String
    Banner message for the web, ssh and serial login. Empty string returns to default

    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