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

checkpoint.Hostname

Explore with Pulumi AI

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

    This resource allows you to set the hostname of a Check Point machine.
    NOTE: This is GAIA API resource and require set provider context to gaia_api.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as checkpoint from "@pulumi/checkpoint";
    
    const hostname = new checkpoint.Hostname("hostname", {});
    
    import pulumi
    import pulumi_checkpoint as checkpoint
    
    hostname = checkpoint.Hostname("hostname")
    
    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.NewHostname(ctx, "hostname", nil)
    		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 hostname = new Checkpoint.Hostname("hostname");
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.checkpoint.Hostname;
    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 hostname = new Hostname("hostname");
    
        }
    }
    
    resources:
      hostname:
        type: checkpoint:Hostname
    

    Create Hostname Resource

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

    Constructor syntax

    new Hostname(name: string, args?: HostnameArgs, opts?: CustomResourceOptions);
    @overload
    def Hostname(resource_name: str,
                 args: Optional[HostnameArgs] = None,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def Hostname(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 hostname_id: Optional[str] = None,
                 name: Optional[str] = None)
    func NewHostname(ctx *Context, name string, args *HostnameArgs, opts ...ResourceOption) (*Hostname, error)
    public Hostname(string name, HostnameArgs? args = null, CustomResourceOptions? opts = null)
    public Hostname(String name, HostnameArgs args)
    public Hostname(String name, HostnameArgs args, CustomResourceOptions options)
    
    type: checkpoint:Hostname
    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 HostnameArgs
    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 HostnameArgs
    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 HostnameArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args HostnameArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args HostnameArgs
    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 hostnameResource = new Checkpoint.Hostname("hostnameResource", new()
    {
        HostnameId = "string",
        Name = "string",
    });
    
    example, err := checkpoint.NewHostname(ctx, "hostnameResource", &checkpoint.HostnameArgs{
    	HostnameId: pulumi.String("string"),
    	Name:       pulumi.String("string"),
    })
    
    var hostnameResource = new Hostname("hostnameResource", HostnameArgs.builder()
        .hostnameId("string")
        .name("string")
        .build());
    
    hostname_resource = checkpoint.Hostname("hostnameResource",
        hostname_id="string",
        name="string")
    
    const hostnameResource = new checkpoint.Hostname("hostnameResource", {
        hostnameId: "string",
        name: "string",
    });
    
    type: checkpoint:Hostname
    properties:
        hostnameId: string
        name: string
    

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

    HostnameId string
    Name string
    New hostname to change.
    HostnameId string
    Name string
    New hostname to change.
    hostnameId String
    name String
    New hostname to change.
    hostnameId string
    name string
    New hostname to change.
    hostname_id str
    name str
    New hostname to change.
    hostnameId String
    name String
    New hostname to change.

    Outputs

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

    Get an existing Hostname 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?: HostnameState, opts?: CustomResourceOptions): Hostname
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            hostname_id: Optional[str] = None,
            name: Optional[str] = None) -> Hostname
    func GetHostname(ctx *Context, name string, id IDInput, state *HostnameState, opts ...ResourceOption) (*Hostname, error)
    public static Hostname Get(string name, Input<string> id, HostnameState? state, CustomResourceOptions? opts = null)
    public static Hostname get(String name, Output<String> id, HostnameState state, CustomResourceOptions options)
    resources:  _:    type: checkpoint:Hostname    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:
    HostnameId string
    Name string
    New hostname to change.
    HostnameId string
    Name string
    New hostname to change.
    hostnameId String
    name String
    New hostname to change.
    hostnameId string
    name string
    New hostname to change.
    hostname_id str
    name str
    New hostname to change.
    hostnameId String
    name String
    New hostname to change.

    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