Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Checkpoint Provider
  3. API Docs
  4. ManagementCommandGaiaApi
checkpoint 2.9.0 published on Monday, Apr 14, 2025 by checkpointsw
checkpointsw/terraform-provider-checkpoint

checkpoint.ManagementCommandGaiaApi

Explore with Pulumi AI

checkpoint logo
checkpoint 2.9.0 published on Monday, Apr 14, 2025 by checkpointsw
checkpointsw/terraform-provider-checkpoint

    Create ManagementCommandGaiaApi Resource

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

    Constructor syntax

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

@overload
def ManagementCommandGaiaApi(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             command_name: Optional[str] = None,
                             target: Optional[str] = None,
                             management_command_gaia_api_id: Optional[str] = None,
                             other_parameter: Optional[str] = None)
    func NewManagementCommandGaiaApi(ctx *Context, name string, args ManagementCommandGaiaApiArgs, opts ...ResourceOption) (*ManagementCommandGaiaApi, error)
    public ManagementCommandGaiaApi(string name, ManagementCommandGaiaApiArgs args, CustomResourceOptions? opts = null)
    public ManagementCommandGaiaApi(String name, ManagementCommandGaiaApiArgs args)
public ManagementCommandGaiaApi(String name, ManagementCommandGaiaApiArgs args, CustomResourceOptions options)

    type: checkpoint:ManagementCommandGaiaApi
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 ManagementCommandGaiaApiArgs
    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 ManagementCommandGaiaApiArgs
    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 ManagementCommandGaiaApiArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ManagementCommandGaiaApiArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ManagementCommandGaiaApiArgs
    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 managementCommandGaiaApiResource = new Checkpoint.ManagementCommandGaiaApi("managementCommandGaiaApiResource", new()
{
    CommandName = "string",
    Target = "string",
    ManagementCommandGaiaApiId = "string",
    OtherParameter = "string",
});

    example, err := checkpoint.NewManagementCommandGaiaApi(ctx, "managementCommandGaiaApiResource", &checkpoint.ManagementCommandGaiaApiArgs{
	CommandName:                pulumi.String("string"),
	Target:                     pulumi.String("string"),
	ManagementCommandGaiaApiId: pulumi.String("string"),
	OtherParameter:             pulumi.String("string"),
})

    var managementCommandGaiaApiResource = new ManagementCommandGaiaApi("managementCommandGaiaApiResource", ManagementCommandGaiaApiArgs.builder()
    .commandName("string")
    .target("string")
    .managementCommandGaiaApiId("string")
    .otherParameter("string")
    .build());

    management_command_gaia_api_resource = checkpoint.ManagementCommandGaiaApi("managementCommandGaiaApiResource",
    command_name="string",
    target="string",
    management_command_gaia_api_id="string",
    other_parameter="string")

    const managementCommandGaiaApiResource = new checkpoint.ManagementCommandGaiaApi("managementCommandGaiaApiResource", {
    commandName: "string",
    target: "string",
    managementCommandGaiaApiId: "string",
    otherParameter: "string",
});

    type: checkpoint:ManagementCommandGaiaApi
properties:
    commandName: string
    managementCommandGaiaApiId: string
    otherParameter: string
    target: string

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

    CommandName string
    GAIA API command name or path
    Target string
    Gateway object name or Gateway IP address or Gateway UID
    ManagementCommandGaiaApiId string
    OtherParameter string
    Other input parameters for the request payload in JSON format
    CommandName string
    GAIA API command name or path
    Target string
    Gateway object name or Gateway IP address or Gateway UID
    ManagementCommandGaiaApiId string
    OtherParameter string
    Other input parameters for the request payload in JSON format
    commandName String
    GAIA API command name or path
    target String
    Gateway object name or Gateway IP address or Gateway UID
    managementCommandGaiaApiId String
    otherParameter String
    Other input parameters for the request payload in JSON format
    commandName string
    GAIA API command name or path
    target string
    Gateway object name or Gateway IP address or Gateway UID
    managementCommandGaiaApiId string
    otherParameter string
    Other input parameters for the request payload in JSON format
    command_name str
    GAIA API command name or path
    target str
    Gateway object name or Gateway IP address or Gateway UID
    management_command_gaia_api_id str
    other_parameter str
    Other input parameters for the request payload in JSON format
    commandName String
    GAIA API command name or path
    target String
    Gateway object name or Gateway IP address or Gateway UID
    managementCommandGaiaApiId String
    otherParameter String
    Other input parameters for the request payload in JSON format

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    ResponseMessage string
    Response message in JSON format
    Id string
    The provider-assigned unique ID for this managed resource.
    ResponseMessage string
    Response message in JSON format
    id String
    The provider-assigned unique ID for this managed resource.
    responseMessage String
    Response message in JSON format
    id string
    The provider-assigned unique ID for this managed resource.
    responseMessage string
    Response message in JSON format
    id str
    The provider-assigned unique ID for this managed resource.
    response_message str
    Response message in JSON format
    id String
    The provider-assigned unique ID for this managed resource.
    responseMessage String
    Response message in JSON format

    Look up Existing ManagementCommandGaiaApi Resource

    Get an existing ManagementCommandGaiaApi 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?: ManagementCommandGaiaApiState, opts?: CustomResourceOptions): ManagementCommandGaiaApi
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        command_name: Optional[str] = None,
        management_command_gaia_api_id: Optional[str] = None,
        other_parameter: Optional[str] = None,
        response_message: Optional[str] = None,
        target: Optional[str] = None) -> ManagementCommandGaiaApi
    func GetManagementCommandGaiaApi(ctx *Context, name string, id IDInput, state *ManagementCommandGaiaApiState, opts ...ResourceOption) (*ManagementCommandGaiaApi, error)
    public static ManagementCommandGaiaApi Get(string name, Input<string> id, ManagementCommandGaiaApiState? state, CustomResourceOptions? opts = null)
    public static ManagementCommandGaiaApi get(String name, Output<String> id, ManagementCommandGaiaApiState state, CustomResourceOptions options)
    resources:  _:    type: checkpoint:ManagementCommandGaiaApi    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:
    CommandName string
    GAIA API command name or path
    ManagementCommandGaiaApiId string
    OtherParameter string
    Other input parameters for the request payload in JSON format
    ResponseMessage string
    Response message in JSON format
    Target string
    Gateway object name or Gateway IP address or Gateway UID
    CommandName string
    GAIA API command name or path
    ManagementCommandGaiaApiId string
    OtherParameter string
    Other input parameters for the request payload in JSON format
    ResponseMessage string
    Response message in JSON format
    Target string
    Gateway object name or Gateway IP address or Gateway UID
    commandName String
    GAIA API command name or path
    managementCommandGaiaApiId String
    otherParameter String
    Other input parameters for the request payload in JSON format
    responseMessage String
    Response message in JSON format
    target String
    Gateway object name or Gateway IP address or Gateway UID
    commandName string
    GAIA API command name or path
    managementCommandGaiaApiId string
    otherParameter string
    Other input parameters for the request payload in JSON format
    responseMessage string
    Response message in JSON format
    target string
    Gateway object name or Gateway IP address or Gateway UID
    command_name str
    GAIA API command name or path
    management_command_gaia_api_id str
    other_parameter str
    Other input parameters for the request payload in JSON format
    response_message str
    Response message in JSON format
    target str
    Gateway object name or Gateway IP address or Gateway UID
    commandName String
    GAIA API command name or path
    managementCommandGaiaApiId String
    otherParameter String
    Other input parameters for the request payload in JSON format
    responseMessage String
    Response message in JSON format
    target String
    Gateway object name or Gateway IP address or Gateway UID

    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
    checkpointsw/terraform-provider-checkpoint