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

checkpoint.GaiaCommandGetFile

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

    Create GaiaCommandGetFile Resource

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

    Constructor syntax

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

@overload
def GaiaCommandGetFile(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       file_name: Optional[str] = None,
                       debug: Optional[bool] = None,
                       gaia_command_get_file_id: Optional[str] = None)
    func NewGaiaCommandGetFile(ctx *Context, name string, args GaiaCommandGetFileArgs, opts ...ResourceOption) (*GaiaCommandGetFile, error)
    public GaiaCommandGetFile(string name, GaiaCommandGetFileArgs args, CustomResourceOptions? opts = null)
    public GaiaCommandGetFile(String name, GaiaCommandGetFileArgs args)
public GaiaCommandGetFile(String name, GaiaCommandGetFileArgs args, CustomResourceOptions options)

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


    resource "checkpoint_gaiacommandgetfile" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args GaiaCommandGetFileArgs
    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 GaiaCommandGetFileArgs
    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 GaiaCommandGetFileArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GaiaCommandGetFileArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GaiaCommandGetFileArgs
    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 gaiaCommandGetFileResource = new Checkpoint.GaiaCommandGetFile("gaiaCommandGetFileResource", new()
{
    FileName = "string",
    Debug = false,
    GaiaCommandGetFileId = "string",
});

    example, err := checkpoint.NewGaiaCommandGetFile(ctx, "gaiaCommandGetFileResource", &checkpoint.GaiaCommandGetFileArgs{
	FileName:             pulumi.String("string"),
	Debug:                pulumi.Bool(false),
	GaiaCommandGetFileId: pulumi.String("string"),
})

    resource "checkpoint_gaiacommandgetfile" "gaiaCommandGetFileResource" {
  file_name                = "string"
  debug                    = false
  gaia_command_get_file_id = "string"
}

    var gaiaCommandGetFileResource = new GaiaCommandGetFile("gaiaCommandGetFileResource", GaiaCommandGetFileArgs.builder()
    .fileName("string")
    .debug(false)
    .gaiaCommandGetFileId("string")
    .build());

    gaia_command_get_file_resource = checkpoint.GaiaCommandGetFile("gaiaCommandGetFileResource",
    file_name="string",
    debug=False,
    gaia_command_get_file_id="string")

    const gaiaCommandGetFileResource = new checkpoint.GaiaCommandGetFile("gaiaCommandGetFileResource", {
    fileName: "string",
    debug: false,
    gaiaCommandGetFileId: "string",
});

    type: checkpoint:GaiaCommandGetFile
properties:
    debug: false
    fileName: string
    gaiaCommandGetFileId: string

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

    FileName string
    Filename include the desired path. The file will be created in the user home directory if the full path wasn't provided
    Debug bool
    Enable debugging for this resource only.
    GaiaCommandGetFileId string
    FileName string
    Filename include the desired path. The file will be created in the user home directory if the full path wasn't provided
    Debug bool
    Enable debugging for this resource only.
    GaiaCommandGetFileId string
    file_name string
    Filename include the desired path. The file will be created in the user home directory if the full path wasn't provided
    debug bool
    Enable debugging for this resource only.
    gaia_command_get_file_id string
    fileName String
    Filename include the desired path. The file will be created in the user home directory if the full path wasn't provided
    debug Boolean
    Enable debugging for this resource only.
    gaiaCommandGetFileId String
    fileName string
    Filename include the desired path. The file will be created in the user home directory if the full path wasn't provided
    debug boolean
    Enable debugging for this resource only.
    gaiaCommandGetFileId string
    file_name str
    Filename include the desired path. The file will be created in the user home directory if the full path wasn't provided
    debug bool
    Enable debugging for this resource only.
    gaia_command_get_file_id str
    fileName String
    Filename include the desired path. The file will be created in the user home directory if the full path wasn't provided
    debug Boolean
    Enable debugging for this resource only.
    gaiaCommandGetFileId String

    Outputs

    All input properties are implicitly available as output properties. Additionally, the GaiaCommandGetFile resource produces the following output properties:

    GroupOwnership string
    N/A
    Id string
    The provider-assigned unique ID for this managed resource.
    Permissions double
    N/A
    TextContent string
    N/A
    UserOwnership string
    N/A
    GroupOwnership string
    N/A
    Id string
    The provider-assigned unique ID for this managed resource.
    Permissions float64
    N/A
    TextContent string
    N/A
    UserOwnership string
    N/A
    group_ownership string
    N/A
    id string
    The provider-assigned unique ID for this managed resource.
    permissions number
    N/A
    text_content string
    N/A
    user_ownership string
    N/A
    groupOwnership String
    N/A
    id String
    The provider-assigned unique ID for this managed resource.
    permissions Double
    N/A
    textContent String
    N/A
    userOwnership String
    N/A
    groupOwnership string
    N/A
    id string
    The provider-assigned unique ID for this managed resource.
    permissions number
    N/A
    textContent string
    N/A
    userOwnership string
    N/A
    group_ownership str
    N/A
    id str
    The provider-assigned unique ID for this managed resource.
    permissions float
    N/A
    text_content str
    N/A
    user_ownership str
    N/A
    groupOwnership String
    N/A
    id String
    The provider-assigned unique ID for this managed resource.
    permissions Number
    N/A
    textContent String
    N/A
    userOwnership String
    N/A

    Look up Existing GaiaCommandGetFile Resource

    Get an existing GaiaCommandGetFile 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?: GaiaCommandGetFileState, opts?: CustomResourceOptions): GaiaCommandGetFile
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        debug: Optional[bool] = None,
        file_name: Optional[str] = None,
        gaia_command_get_file_id: Optional[str] = None,
        group_ownership: Optional[str] = None,
        permissions: Optional[float] = None,
        text_content: Optional[str] = None,
        user_ownership: Optional[str] = None) -> GaiaCommandGetFile
    func GetGaiaCommandGetFile(ctx *Context, name string, id IDInput, state *GaiaCommandGetFileState, opts ...ResourceOption) (*GaiaCommandGetFile, error)
    public static GaiaCommandGetFile Get(string name, Input<string> id, GaiaCommandGetFileState? state, CustomResourceOptions? opts = null)
    public static GaiaCommandGetFile get(String name, Output<String> id, GaiaCommandGetFileState state, CustomResourceOptions options)
    resources:  _:    type: checkpoint:GaiaCommandGetFile    get:      id: ${id}
    import {
  to = checkpoint_gaiacommandgetfile.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 debugging for this resource only.
    FileName string
    Filename include the desired path. The file will be created in the user home directory if the full path wasn't provided
    GaiaCommandGetFileId string
    GroupOwnership string
    N/A
    Permissions double
    N/A
    TextContent string
    N/A
    UserOwnership string
    N/A
    Debug bool
    Enable debugging for this resource only.
    FileName string
    Filename include the desired path. The file will be created in the user home directory if the full path wasn't provided
    GaiaCommandGetFileId string
    GroupOwnership string
    N/A
    Permissions float64
    N/A
    TextContent string
    N/A
    UserOwnership string
    N/A
    debug bool
    Enable debugging for this resource only.
    file_name string
    Filename include the desired path. The file will be created in the user home directory if the full path wasn't provided
    gaia_command_get_file_id string
    group_ownership string
    N/A
    permissions number
    N/A
    text_content string
    N/A
    user_ownership string
    N/A
    debug Boolean
    Enable debugging for this resource only.
    fileName String
    Filename include the desired path. The file will be created in the user home directory if the full path wasn't provided
    gaiaCommandGetFileId String
    groupOwnership String
    N/A
    permissions Double
    N/A
    textContent String
    N/A
    userOwnership String
    N/A
    debug boolean
    Enable debugging for this resource only.
    fileName string
    Filename include the desired path. The file will be created in the user home directory if the full path wasn't provided
    gaiaCommandGetFileId string
    groupOwnership string
    N/A
    permissions number
    N/A
    textContent string
    N/A
    userOwnership string
    N/A
    debug bool
    Enable debugging for this resource only.
    file_name str
    Filename include the desired path. The file will be created in the user home directory if the full path wasn't provided
    gaia_command_get_file_id str
    group_ownership str
    N/A
    permissions float
    N/A
    text_content str
    N/A
    user_ownership str
    N/A
    debug Boolean
    Enable debugging for this resource only.
    fileName String
    Filename include the desired path. The file will be created in the user home directory if the full path wasn't provided
    gaiaCommandGetFileId String
    groupOwnership String
    N/A
    permissions Number
    N/A
    textContent String
    N/A
    userOwnership String
    N/A

    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