dome9.Integration
Explore with Pulumi AI
—
layout: “dome9” page_title: “Check Point CloudGuard: dome9.Integration” sidebar_current: “docs-resource-dome9-integration” description: |- Creates and manages CloudGuard integrations.
dome9.Integration
This resource is used to create and manage CloudGuard integrations. Integrations in CloudGuard allow you to connect and configure supported third-party services and tools.
Example Usage
Basic usage:
import * as pulumi from "@pulumi/pulumi";
import * as dome9 from "@pulumi/dome9";
const exampleIntegration = new dome9.Integration("exampleIntegration", {
type: "webhook",
configuration: JSON.stringify({
Url: "https://example.com/webhook",
MethodType: "Post",
AuthType: "BasicAuth",
Username: "example-username",
Password: "example-password",
IgnoreCertificate: true,
}),
});
import pulumi
import json
import pulumi_dome9 as dome9
example_integration = dome9.Integration("exampleIntegration",
type="webhook",
configuration=json.dumps({
"Url": "https://example.com/webhook",
"MethodType": "Post",
"AuthType": "BasicAuth",
"Username": "example-username",
"Password": "example-password",
"IgnoreCertificate": True,
}))
package main
import (
"encoding/json"
"github.com/pulumi/pulumi-terraform-provider/sdks/go/dome9/dome9"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
tmpJSON0, err := json.Marshal(map[string]interface{}{
"Url": "https://example.com/webhook",
"MethodType": "Post",
"AuthType": "BasicAuth",
"Username": "example-username",
"Password": "example-password",
"IgnoreCertificate": true,
})
if err != nil {
return err
}
json0 := string(tmpJSON0)
_, err = dome9.NewIntegration(ctx, "exampleIntegration", &dome9.IntegrationArgs{
Type: pulumi.String("webhook"),
Configuration: pulumi.String(json0),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Dome9 = Pulumi.Dome9;
return await Deployment.RunAsync(() =>
{
var exampleIntegration = new Dome9.Integration("exampleIntegration", new()
{
Type = "webhook",
Configuration = JsonSerializer.Serialize(new Dictionary<string, object?>
{
["Url"] = "https://example.com/webhook",
["MethodType"] = "Post",
["AuthType"] = "BasicAuth",
["Username"] = "example-username",
["Password"] = "example-password",
["IgnoreCertificate"] = true,
}),
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.dome9.Integration;
import com.pulumi.dome9.IntegrationArgs;
import static com.pulumi.codegen.internal.Serialization.*;
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 exampleIntegration = new Integration("exampleIntegration", IntegrationArgs.builder()
.type("webhook")
.configuration(serializeJson(
jsonObject(
jsonProperty("Url", "https://example.com/webhook"),
jsonProperty("MethodType", "Post"),
jsonProperty("AuthType", "BasicAuth"),
jsonProperty("Username", "example-username"),
jsonProperty("Password", "example-password"),
jsonProperty("IgnoreCertificate", true)
)))
.build());
}
}
resources:
exampleIntegration:
type: dome9:Integration
properties:
type: webhook
configuration:
fn::toJSON:
Url: https://example.com/webhook
MethodType: Post
AuthType: BasicAuth
Username: example-username
Password: example-password
IgnoreCertificate: true
Create Integration Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Integration(name: string, args: IntegrationArgs, opts?: CustomResourceOptions);
@overload
def Integration(resource_name: str,
args: IntegrationArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Integration(resource_name: str,
opts: Optional[ResourceOptions] = None,
configuration: Optional[str] = None,
type: Optional[str] = None,
integration_id: Optional[str] = None,
name: Optional[str] = None)
func NewIntegration(ctx *Context, name string, args IntegrationArgs, opts ...ResourceOption) (*Integration, error)
public Integration(string name, IntegrationArgs args, CustomResourceOptions? opts = null)
public Integration(String name, IntegrationArgs args)
public Integration(String name, IntegrationArgs args, CustomResourceOptions options)
type: dome9:Integration
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 IntegrationArgs
- 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 IntegrationArgs
- 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 IntegrationArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args IntegrationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args IntegrationArgs
- 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 integrationResource = new Dome9.Integration("integrationResource", new()
{
Configuration = "string",
Type = "string",
IntegrationId = "string",
Name = "string",
});
example, err := dome9.NewIntegration(ctx, "integrationResource", &dome9.IntegrationArgs{
Configuration: pulumi.String("string"),
Type: pulumi.String("string"),
IntegrationId: pulumi.String("string"),
Name: pulumi.String("string"),
})
var integrationResource = new Integration("integrationResource", IntegrationArgs.builder()
.configuration("string")
.type("string")
.integrationId("string")
.name("string")
.build());
integration_resource = dome9.Integration("integrationResource",
configuration="string",
type="string",
integration_id="string",
name="string")
const integrationResource = new dome9.Integration("integrationResource", {
configuration: "string",
type: "string",
integrationId: "string",
name: "string",
});
type: dome9:Integration
properties:
configuration: string
integrationId: string
name: string
type: string
Integration 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 Integration resource accepts the following input properties:
- Configuration string
- The configuration of the integration in JSON format. The configuration should contain all required details for the integration configuration.
- Configuration details for each integration type can be found in the CloudGuard API documentation.
- Type string
- The type of the integration. Possible values are:
SNS
Email
PagerDuty
AwsSecurityHub
AzureDefender
GcpSecurityCommandCenter
Webhook
ServiceNow
Splunk
Jira
SumoLogic
QRadar
Slack
Teams
- Integration
Id string - Name string
- The name of the integration.
- Configuration string
- The configuration of the integration in JSON format. The configuration should contain all required details for the integration configuration.
- Configuration details for each integration type can be found in the CloudGuard API documentation.
- Type string
- The type of the integration. Possible values are:
SNS
Email
PagerDuty
AwsSecurityHub
AzureDefender
GcpSecurityCommandCenter
Webhook
ServiceNow
Splunk
Jira
SumoLogic
QRadar
Slack
Teams
- Integration
Id string - Name string
- The name of the integration.
- configuration String
- The configuration of the integration in JSON format. The configuration should contain all required details for the integration configuration.
- Configuration details for each integration type can be found in the CloudGuard API documentation.
- type String
- The type of the integration. Possible values are:
SNS
Email
PagerDuty
AwsSecurityHub
AzureDefender
GcpSecurityCommandCenter
Webhook
ServiceNow
Splunk
Jira
SumoLogic
QRadar
Slack
Teams
- integration
Id String - name String
- The name of the integration.
- configuration string
- The configuration of the integration in JSON format. The configuration should contain all required details for the integration configuration.
- Configuration details for each integration type can be found in the CloudGuard API documentation.
- type string
- The type of the integration. Possible values are:
SNS
Email
PagerDuty
AwsSecurityHub
AzureDefender
GcpSecurityCommandCenter
Webhook
ServiceNow
Splunk
Jira
SumoLogic
QRadar
Slack
Teams
- integration
Id string - name string
- The name of the integration.
- configuration str
- The configuration of the integration in JSON format. The configuration should contain all required details for the integration configuration.
- Configuration details for each integration type can be found in the CloudGuard API documentation.
- type str
- The type of the integration. Possible values are:
SNS
Email
PagerDuty
AwsSecurityHub
AzureDefender
GcpSecurityCommandCenter
Webhook
ServiceNow
Splunk
Jira
SumoLogic
QRadar
Slack
Teams
- integration_
id str - name str
- The name of the integration.
- configuration String
- The configuration of the integration in JSON format. The configuration should contain all required details for the integration configuration.
- Configuration details for each integration type can be found in the CloudGuard API documentation.
- type String
- The type of the integration. Possible values are:
SNS
Email
PagerDuty
AwsSecurityHub
AzureDefender
GcpSecurityCommandCenter
Webhook
ServiceNow
Splunk
Jira
SumoLogic
QRadar
Slack
Teams
- integration
Id String - name String
- The name of the integration.
Outputs
All input properties are implicitly available as output properties. Additionally, the Integration 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 Integration Resource
Get an existing Integration 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?: IntegrationState, opts?: CustomResourceOptions): Integration
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
configuration: Optional[str] = None,
integration_id: Optional[str] = None,
name: Optional[str] = None,
type: Optional[str] = None) -> Integration
func GetIntegration(ctx *Context, name string, id IDInput, state *IntegrationState, opts ...ResourceOption) (*Integration, error)
public static Integration Get(string name, Input<string> id, IntegrationState? state, CustomResourceOptions? opts = null)
public static Integration get(String name, Output<String> id, IntegrationState state, CustomResourceOptions options)
resources: _: type: dome9:Integration 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.
- Configuration string
- The configuration of the integration in JSON format. The configuration should contain all required details for the integration configuration.
- Configuration details for each integration type can be found in the CloudGuard API documentation.
- Integration
Id string - Name string
- The name of the integration.
- Type string
- The type of the integration. Possible values are:
SNS
Email
PagerDuty
AwsSecurityHub
AzureDefender
GcpSecurityCommandCenter
Webhook
ServiceNow
Splunk
Jira
SumoLogic
QRadar
Slack
Teams
- Configuration string
- The configuration of the integration in JSON format. The configuration should contain all required details for the integration configuration.
- Configuration details for each integration type can be found in the CloudGuard API documentation.
- Integration
Id string - Name string
- The name of the integration.
- Type string
- The type of the integration. Possible values are:
SNS
Email
PagerDuty
AwsSecurityHub
AzureDefender
GcpSecurityCommandCenter
Webhook
ServiceNow
Splunk
Jira
SumoLogic
QRadar
Slack
Teams
- configuration String
- The configuration of the integration in JSON format. The configuration should contain all required details for the integration configuration.
- Configuration details for each integration type can be found in the CloudGuard API documentation.
- integration
Id String - name String
- The name of the integration.
- type String
- The type of the integration. Possible values are:
SNS
Email
PagerDuty
AwsSecurityHub
AzureDefender
GcpSecurityCommandCenter
Webhook
ServiceNow
Splunk
Jira
SumoLogic
QRadar
Slack
Teams
- configuration string
- The configuration of the integration in JSON format. The configuration should contain all required details for the integration configuration.
- Configuration details for each integration type can be found in the CloudGuard API documentation.
- integration
Id string - name string
- The name of the integration.
- type string
- The type of the integration. Possible values are:
SNS
Email
PagerDuty
AwsSecurityHub
AzureDefender
GcpSecurityCommandCenter
Webhook
ServiceNow
Splunk
Jira
SumoLogic
QRadar
Slack
Teams
- configuration str
- The configuration of the integration in JSON format. The configuration should contain all required details for the integration configuration.
- Configuration details for each integration type can be found in the CloudGuard API documentation.
- integration_
id str - name str
- The name of the integration.
- type str
- The type of the integration. Possible values are:
SNS
Email
PagerDuty
AwsSecurityHub
AzureDefender
GcpSecurityCommandCenter
Webhook
ServiceNow
Splunk
Jira
SumoLogic
QRadar
Slack
Teams
- configuration String
- The configuration of the integration in JSON format. The configuration should contain all required details for the integration configuration.
- Configuration details for each integration type can be found in the CloudGuard API documentation.
- integration
Id String - name String
- The name of the integration.
- type String
- The type of the integration. Possible values are:
SNS
Email
PagerDuty
AwsSecurityHub
AzureDefender
GcpSecurityCommandCenter
Webhook
ServiceNow
Splunk
Jira
SumoLogic
QRadar
Slack
Teams
Import
This resource can be imported using the integration ID, which can be found in the CloudGuard console.
$ pulumi import dome9:index/integration:Integration example <INTEGRATION_ID>
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- dome9 dome9/terraform-provider-dome9
- License
- Notes
- This Pulumi package is based on the
dome9
Terraform Provider.