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

checkpoint.GaiaCommandRunScript

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

    Create GaiaCommandRunScript Resource

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

    Constructor syntax

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

@overload
def GaiaCommandRunScript(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         script: Optional[str] = None,
                         args: Optional[str] = None,
                         debug: Optional[bool] = None,
                         description: Optional[str] = None,
                         environment_variables: Optional[Sequence[GaiaCommandRunScriptEnvironmentVariableArgs]] = None,
                         gaia_command_run_script_id: Optional[str] = None)
    func NewGaiaCommandRunScript(ctx *Context, name string, args GaiaCommandRunScriptArgs, opts ...ResourceOption) (*GaiaCommandRunScript, error)
    public GaiaCommandRunScript(string name, GaiaCommandRunScriptArgs args, CustomResourceOptions? opts = null)
    public GaiaCommandRunScript(String name, GaiaCommandRunScriptArgs args)
public GaiaCommandRunScript(String name, GaiaCommandRunScriptArgs args, CustomResourceOptions options)

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


    resource "checkpoint_gaiacommandrunscript" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args GaiaCommandRunScriptArgs
    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 GaiaCommandRunScriptArgs
    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 GaiaCommandRunScriptArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GaiaCommandRunScriptArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GaiaCommandRunScriptArgs
    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 gaiaCommandRunScriptResource = new Checkpoint.GaiaCommandRunScript("gaiaCommandRunScriptResource", new()
{
    Script = "string",
    Args = "string",
    Debug = false,
    Description = "string",
    EnvironmentVariables = new[]
    {
        new Checkpoint.Inputs.GaiaCommandRunScriptEnvironmentVariableArgs
        {
            Name = "string",
            Value = "string",
        },
    },
    GaiaCommandRunScriptId = "string",
});

    example, err := checkpoint.NewGaiaCommandRunScript(ctx, "gaiaCommandRunScriptResource", &checkpoint.GaiaCommandRunScriptArgs{
	Script:      pulumi.String("string"),
	Args:        pulumi.String("string"),
	Debug:       pulumi.Bool(false),
	Description: pulumi.String("string"),
	EnvironmentVariables: checkpoint.GaiaCommandRunScriptEnvironmentVariableArray{
		&checkpoint.GaiaCommandRunScriptEnvironmentVariableArgs{
			Name:  pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	GaiaCommandRunScriptId: pulumi.String("string"),
})

    resource "checkpoint_gaiacommandrunscript" "gaiaCommandRunScriptResource" {
  script      = "string"
  args        = "string"
  debug       = false
  description = "string"
  environment_variables {
    name  = "string"
    value = "string"
  }
  gaia_command_run_script_id = "string"
}

    var gaiaCommandRunScriptResource = new GaiaCommandRunScript("gaiaCommandRunScriptResource", GaiaCommandRunScriptArgs.builder()
    .script("string")
    .args("string")
    .debug(false)
    .description("string")
    .environmentVariables(GaiaCommandRunScriptEnvironmentVariableArgs.builder()
        .name("string")
        .value("string")
        .build())
    .gaiaCommandRunScriptId("string")
    .build());

    gaia_command_run_script_resource = checkpoint.GaiaCommandRunScript("gaiaCommandRunScriptResource",
    script="string",
    args="string",
    debug=False,
    description="string",
    environment_variables=[{
        "name": "string",
        "value": "string",
    }],
    gaia_command_run_script_id="string")

    const gaiaCommandRunScriptResource = new checkpoint.GaiaCommandRunScript("gaiaCommandRunScriptResource", {
    script: "string",
    args: "string",
    debug: false,
    description: "string",
    environmentVariables: [{
        name: "string",
        value: "string",
    }],
    gaiaCommandRunScriptId: "string",
});

    type: checkpoint:GaiaCommandRunScript
properties:
    args: string
    debug: false
    description: string
    environmentVariables:
        - name: string
          value: string
    gaiaCommandRunScriptId: string
    script: string

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

    Script string
    Script body
    Args string
    Script arguments, separated by space character. Note: don't send sensitive data on this parameter.
    Debug bool
    Enable debugging for this resource only.
    Description string
    Script description
    EnvironmentVariables List<GaiaCommandRunScriptEnvironmentVariable>
    Define environment variables to be used in the script, it's better to send sensitive data on environment variables since it's not stored. environment_variables blocks are documented below.
    GaiaCommandRunScriptId string
    Script string
    Script body
    Args string
    Script arguments, separated by space character. Note: don't send sensitive data on this parameter.
    Debug bool
    Enable debugging for this resource only.
    Description string
    Script description
    EnvironmentVariables []GaiaCommandRunScriptEnvironmentVariableArgs
    Define environment variables to be used in the script, it's better to send sensitive data on environment variables since it's not stored. environment_variables blocks are documented below.
    GaiaCommandRunScriptId string
    script string
    Script body
    args string
    Script arguments, separated by space character. Note: don't send sensitive data on this parameter.
    debug bool
    Enable debugging for this resource only.
    description string
    Script description
    environment_variables list(object)
    Define environment variables to be used in the script, it's better to send sensitive data on environment variables since it's not stored. environment_variables blocks are documented below.
    gaia_command_run_script_id string
    script String
    Script body
    args String
    Script arguments, separated by space character. Note: don't send sensitive data on this parameter.
    debug Boolean
    Enable debugging for this resource only.
    description String
    Script description
    environmentVariables List<GaiaCommandRunScriptEnvironmentVariable>
    Define environment variables to be used in the script, it's better to send sensitive data on environment variables since it's not stored. environment_variables blocks are documented below.
    gaiaCommandRunScriptId String
    script string
    Script body
    args string
    Script arguments, separated by space character. Note: don't send sensitive data on this parameter.
    debug boolean
    Enable debugging for this resource only.
    description string
    Script description
    environmentVariables GaiaCommandRunScriptEnvironmentVariable[]
    Define environment variables to be used in the script, it's better to send sensitive data on environment variables since it's not stored. environment_variables blocks are documented below.
    gaiaCommandRunScriptId string
    script str
    Script body
    args str
    Script arguments, separated by space character. Note: don't send sensitive data on this parameter.
    debug bool
    Enable debugging for this resource only.
    description str
    Script description
    environment_variables Sequence[GaiaCommandRunScriptEnvironmentVariableArgs]
    Define environment variables to be used in the script, it's better to send sensitive data on environment variables since it's not stored. environment_variables blocks are documented below.
    gaia_command_run_script_id str
    script String
    Script body
    args String
    Script arguments, separated by space character. Note: don't send sensitive data on this parameter.
    debug Boolean
    Enable debugging for this resource only.
    description String
    Script description
    environmentVariables List<Property Map>
    Define environment variables to be used in the script, it's better to send sensitive data on environment variables since it's not stored. environment_variables blocks are documented below.
    gaiaCommandRunScriptId String

    Outputs

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

    Error string
    N/A
    Id string
    The provider-assigned unique ID for this managed resource.
    Output string
    N/A
    ReturnValue double
    N/A
    Error string
    N/A
    Id string
    The provider-assigned unique ID for this managed resource.
    Output string
    N/A
    ReturnValue float64
    N/A
    error string
    N/A
    id string
    The provider-assigned unique ID for this managed resource.
    output string
    N/A
    return_value number
    N/A
    error String
    N/A
    id String
    The provider-assigned unique ID for this managed resource.
    output String
    N/A
    returnValue Double
    N/A
    error string
    N/A
    id string
    The provider-assigned unique ID for this managed resource.
    output string
    N/A
    returnValue number
    N/A
    error str
    N/A
    id str
    The provider-assigned unique ID for this managed resource.
    output str
    N/A
    return_value float
    N/A
    error String
    N/A
    id String
    The provider-assigned unique ID for this managed resource.
    output String
    N/A
    returnValue Number
    N/A

    Look up Existing GaiaCommandRunScript Resource

    Get an existing GaiaCommandRunScript 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?: GaiaCommandRunScriptState, opts?: CustomResourceOptions): GaiaCommandRunScript
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        args: Optional[str] = None,
        debug: Optional[bool] = None,
        description: Optional[str] = None,
        environment_variables: Optional[Sequence[GaiaCommandRunScriptEnvironmentVariableArgs]] = None,
        error: Optional[str] = None,
        gaia_command_run_script_id: Optional[str] = None,
        output: Optional[str] = None,
        return_value: Optional[float] = None,
        script: Optional[str] = None) -> GaiaCommandRunScript
    func GetGaiaCommandRunScript(ctx *Context, name string, id IDInput, state *GaiaCommandRunScriptState, opts ...ResourceOption) (*GaiaCommandRunScript, error)
    public static GaiaCommandRunScript Get(string name, Input<string> id, GaiaCommandRunScriptState? state, CustomResourceOptions? opts = null)
    public static GaiaCommandRunScript get(String name, Output<String> id, GaiaCommandRunScriptState state, CustomResourceOptions options)
    resources:  _:    type: checkpoint:GaiaCommandRunScript    get:      id: ${id}
    import {
  to = checkpoint_gaiacommandrunscript.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:
    Args string
    Script arguments, separated by space character. Note: don't send sensitive data on this parameter.
    Debug bool
    Enable debugging for this resource only.
    Description string
    Script description
    EnvironmentVariables List<GaiaCommandRunScriptEnvironmentVariable>
    Define environment variables to be used in the script, it's better to send sensitive data on environment variables since it's not stored. environment_variables blocks are documented below.
    Error string
    N/A
    GaiaCommandRunScriptId string
    Output string
    N/A
    ReturnValue double
    N/A
    Script string
    Script body
    Args string
    Script arguments, separated by space character. Note: don't send sensitive data on this parameter.
    Debug bool
    Enable debugging for this resource only.
    Description string
    Script description
    EnvironmentVariables []GaiaCommandRunScriptEnvironmentVariableArgs
    Define environment variables to be used in the script, it's better to send sensitive data on environment variables since it's not stored. environment_variables blocks are documented below.
    Error string
    N/A
    GaiaCommandRunScriptId string
    Output string
    N/A
    ReturnValue float64
    N/A
    Script string
    Script body
    args string
    Script arguments, separated by space character. Note: don't send sensitive data on this parameter.
    debug bool
    Enable debugging for this resource only.
    description string
    Script description
    environment_variables list(object)
    Define environment variables to be used in the script, it's better to send sensitive data on environment variables since it's not stored. environment_variables blocks are documented below.
    error string
    N/A
    gaia_command_run_script_id string
    output string
    N/A
    return_value number
    N/A
    script string
    Script body
    args String
    Script arguments, separated by space character. Note: don't send sensitive data on this parameter.
    debug Boolean
    Enable debugging for this resource only.
    description String
    Script description
    environmentVariables List<GaiaCommandRunScriptEnvironmentVariable>
    Define environment variables to be used in the script, it's better to send sensitive data on environment variables since it's not stored. environment_variables blocks are documented below.
    error String
    N/A
    gaiaCommandRunScriptId String
    output String
    N/A
    returnValue Double
    N/A
    script String
    Script body
    args string
    Script arguments, separated by space character. Note: don't send sensitive data on this parameter.
    debug boolean
    Enable debugging for this resource only.
    description string
    Script description
    environmentVariables GaiaCommandRunScriptEnvironmentVariable[]
    Define environment variables to be used in the script, it's better to send sensitive data on environment variables since it's not stored. environment_variables blocks are documented below.
    error string
    N/A
    gaiaCommandRunScriptId string
    output string
    N/A
    returnValue number
    N/A
    script string
    Script body
    args str
    Script arguments, separated by space character. Note: don't send sensitive data on this parameter.
    debug bool
    Enable debugging for this resource only.
    description str
    Script description
    environment_variables Sequence[GaiaCommandRunScriptEnvironmentVariableArgs]
    Define environment variables to be used in the script, it's better to send sensitive data on environment variables since it's not stored. environment_variables blocks are documented below.
    error str
    N/A
    gaia_command_run_script_id str
    output str
    N/A
    return_value float
    N/A
    script str
    Script body
    args String
    Script arguments, separated by space character. Note: don't send sensitive data on this parameter.
    debug Boolean
    Enable debugging for this resource only.
    description String
    Script description
    environmentVariables List<Property Map>
    Define environment variables to be used in the script, it's better to send sensitive data on environment variables since it's not stored. environment_variables blocks are documented below.
    error String
    N/A
    gaiaCommandRunScriptId String
    output String
    N/A
    returnValue Number
    N/A
    script String
    Script body

    Supporting Types

    GaiaCommandRunScriptEnvironmentVariable, GaiaCommandRunScriptEnvironmentVariableArgs

    Name string
    Variable's name
    Value string
    Variable's value
    Name string
    Variable's name
    Value string
    Variable's value
    name string
    Variable's name
    value string
    Variable's value
    name String
    Variable's name
    value String
    Variable's value
    name string
    Variable's name
    value string
    Variable's value
    name str
    Variable's name
    value str
    Variable's value
    name String
    Variable's name
    value String
    Variable's value

    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