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

checkpoint.ManagementRunScript

Explore with Pulumi AI

Create ManagementRunScript Resource

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

Constructor syntax

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

@overload
def ManagementRunScript(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        script: Optional[str] = None,
                        script_name: Optional[str] = None,
                        targets: Optional[Sequence[str]] = None,
                        args: Optional[str] = None,
                        comments: Optional[str] = None,
                        management_run_script_id: Optional[str] = None)
func NewManagementRunScript(ctx *Context, name string, args ManagementRunScriptArgs, opts ...ResourceOption) (*ManagementRunScript, error)
public ManagementRunScript(string name, ManagementRunScriptArgs args, CustomResourceOptions? opts = null)
public ManagementRunScript(String name, ManagementRunScriptArgs args)
public ManagementRunScript(String name, ManagementRunScriptArgs args, CustomResourceOptions options)
type: checkpoint:ManagementRunScript
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ManagementRunScriptArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ManagementRunScriptArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ManagementRunScriptArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ManagementRunScriptArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ManagementRunScriptArgs
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 managementRunScriptResource = new Checkpoint.ManagementRunScript("managementRunScriptResource", new()
{
    Script = "string",
    ScriptName = "string",
    Targets = new[]
    {
        "string",
    },
    Args = "string",
    Comments = "string",
    ManagementRunScriptId = "string",
});
Copy
example, err := checkpoint.NewManagementRunScript(ctx, "managementRunScriptResource", &checkpoint.ManagementRunScriptArgs{
Script: pulumi.String("string"),
ScriptName: pulumi.String("string"),
Targets: pulumi.StringArray{
pulumi.String("string"),
},
Args: pulumi.String("string"),
Comments: pulumi.String("string"),
ManagementRunScriptId: pulumi.String("string"),
})
Copy
var managementRunScriptResource = new ManagementRunScript("managementRunScriptResource", ManagementRunScriptArgs.builder()
    .script("string")
    .scriptName("string")
    .targets("string")
    .args("string")
    .comments("string")
    .managementRunScriptId("string")
    .build());
Copy
management_run_script_resource = checkpoint.ManagementRunScript("managementRunScriptResource",
    script="string",
    script_name="string",
    targets=["string"],
    args="string",
    comments="string",
    management_run_script_id="string")
Copy
const managementRunScriptResource = new checkpoint.ManagementRunScript("managementRunScriptResource", {
    script: "string",
    scriptName: "string",
    targets: ["string"],
    args: "string",
    comments: "string",
    managementRunScriptId: "string",
});
Copy
type: checkpoint:ManagementRunScript
properties:
    args: string
    comments: string
    managementRunScriptId: string
    script: string
    scriptName: string
    targets:
        - string
Copy

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

Script This property is required. string
Script body.
ScriptName This property is required. string
Script name.
Targets This property is required. List<string>
On what targets to execute this command. Targets may be identified by their name, or object unique identifier.targets blocks are documented below.
Args string
Script arguments.
Comments string
Comments string.
ManagementRunScriptId string
Script This property is required. string
Script body.
ScriptName This property is required. string
Script name.
Targets This property is required. []string
On what targets to execute this command. Targets may be identified by their name, or object unique identifier.targets blocks are documented below.
Args string
Script arguments.
Comments string
Comments string.
ManagementRunScriptId string
script This property is required. String
Script body.
scriptName This property is required. String
Script name.
targets This property is required. List<String>
On what targets to execute this command. Targets may be identified by their name, or object unique identifier.targets blocks are documented below.
args String
Script arguments.
comments String
Comments string.
managementRunScriptId String
script This property is required. string
Script body.
scriptName This property is required. string
Script name.
targets This property is required. string[]
On what targets to execute this command. Targets may be identified by their name, or object unique identifier.targets blocks are documented below.
args string
Script arguments.
comments string
Comments string.
managementRunScriptId string
script This property is required. str
Script body.
script_name This property is required. str
Script name.
targets This property is required. Sequence[str]
On what targets to execute this command. Targets may be identified by their name, or object unique identifier.targets blocks are documented below.
args str
Script arguments.
comments str
Comments string.
management_run_script_id str
script This property is required. String
Script body.
scriptName This property is required. String
Script name.
targets This property is required. List<String>
On what targets to execute this command. Targets may be identified by their name, or object unique identifier.targets blocks are documented below.
args String
Script arguments.
comments String
Comments string.
managementRunScriptId String

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Tasks List<string>
Collection of asynchronous task unique identifiers.
Id string
The provider-assigned unique ID for this managed resource.
Tasks []string
Collection of asynchronous task unique identifiers.
id String
The provider-assigned unique ID for this managed resource.
tasks List<String>
Collection of asynchronous task unique identifiers.
id string
The provider-assigned unique ID for this managed resource.
tasks string[]
Collection of asynchronous task unique identifiers.
id str
The provider-assigned unique ID for this managed resource.
tasks Sequence[str]
Collection of asynchronous task unique identifiers.
id String
The provider-assigned unique ID for this managed resource.
tasks List<String>
Collection of asynchronous task unique identifiers.

Look up Existing ManagementRunScript Resource

Get an existing ManagementRunScript 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?: ManagementRunScriptState, opts?: CustomResourceOptions): ManagementRunScript
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        args: Optional[str] = None,
        comments: Optional[str] = None,
        management_run_script_id: Optional[str] = None,
        script: Optional[str] = None,
        script_name: Optional[str] = None,
        targets: Optional[Sequence[str]] = None,
        tasks: Optional[Sequence[str]] = None) -> ManagementRunScript
func GetManagementRunScript(ctx *Context, name string, id IDInput, state *ManagementRunScriptState, opts ...ResourceOption) (*ManagementRunScript, error)
public static ManagementRunScript Get(string name, Input<string> id, ManagementRunScriptState? state, CustomResourceOptions? opts = null)
public static ManagementRunScript get(String name, Output<String> id, ManagementRunScriptState state, CustomResourceOptions options)
resources:  _:    type: checkpoint:ManagementRunScript    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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.
Comments string
Comments string.
ManagementRunScriptId string
Script string
Script body.
ScriptName string
Script name.
Targets List<string>
On what targets to execute this command. Targets may be identified by their name, or object unique identifier.targets blocks are documented below.
Tasks List<string>
Collection of asynchronous task unique identifiers.
Args string
Script arguments.
Comments string
Comments string.
ManagementRunScriptId string
Script string
Script body.
ScriptName string
Script name.
Targets []string
On what targets to execute this command. Targets may be identified by their name, or object unique identifier.targets blocks are documented below.
Tasks []string
Collection of asynchronous task unique identifiers.
args String
Script arguments.
comments String
Comments string.
managementRunScriptId String
script String
Script body.
scriptName String
Script name.
targets List<String>
On what targets to execute this command. Targets may be identified by their name, or object unique identifier.targets blocks are documented below.
tasks List<String>
Collection of asynchronous task unique identifiers.
args string
Script arguments.
comments string
Comments string.
managementRunScriptId string
script string
Script body.
scriptName string
Script name.
targets string[]
On what targets to execute this command. Targets may be identified by their name, or object unique identifier.targets blocks are documented below.
tasks string[]
Collection of asynchronous task unique identifiers.
args str
Script arguments.
comments str
Comments string.
management_run_script_id str
script str
Script body.
script_name str
Script name.
targets Sequence[str]
On what targets to execute this command. Targets may be identified by their name, or object unique identifier.targets blocks are documented below.
tasks Sequence[str]
Collection of asynchronous task unique identifiers.
args String
Script arguments.
comments String
Comments string.
managementRunScriptId String
script String
Script body.
scriptName String
Script name.
targets List<String>
On what targets to execute this command. Targets may be identified by their name, or object unique identifier.targets blocks are documented below.
tasks List<String>
Collection of asynchronous task unique identifiers.

Package Details

Repository
checkpoint checkpointsw/terraform-provider-checkpoint
License
Notes
This Pulumi package is based on the checkpoint Terraform Provider.