Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Incapsula Provider
  3. API Docs
  4. SiemConnection
incapsula 3.32.1 published on Monday, Apr 14, 2025 by imperva
imperva/terraform-provider-incapsula

incapsula.SiemConnection

Explore with Pulumi AI

incapsula 3.32.1 published on Monday, Apr 14, 2025 by imperva
imperva/terraform-provider-incapsula

Provides a customer S3 connection configuration resource.

The follow-on action is to use the incapsula.SiemLogConfiguration resource, to configure the connection.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as incapsula from "@pulumi/incapsula";

const exampleSiemConnectionS3Basic = new incapsula.SiemConnection("exampleSiemConnectionS3Basic", {
    accessKey: "AKIAIOSFODNN7EXAMPLE",
    accountId: "1234567",
    connectionName: "APB siem-logs connection basic auth",
    path: "myBucket/siem/logs",
    secretKey: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
    storageType: "CUSTOMER_S3",
});
const exampleSiemConnectionS3Arn = new incapsula.SiemConnection("exampleSiemConnectionS3Arn", {
    accountId: "1234567",
    connectionName: "ABP siem-logs connection arn auth",
    path: "myBucket/siem/logs",
    storageType: "CUSTOMER_S3_ARN",
});
Copy
import pulumi
import pulumi_incapsula as incapsula

example_siem_connection_s3_basic = incapsula.SiemConnection("exampleSiemConnectionS3Basic",
    access_key="AKIAIOSFODNN7EXAMPLE",
    account_id="1234567",
    connection_name="APB siem-logs connection basic auth",
    path="myBucket/siem/logs",
    secret_key="wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
    storage_type="CUSTOMER_S3")
example_siem_connection_s3_arn = incapsula.SiemConnection("exampleSiemConnectionS3Arn",
    account_id="1234567",
    connection_name="ABP siem-logs connection arn auth",
    path="myBucket/siem/logs",
    storage_type="CUSTOMER_S3_ARN")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/incapsula/v3/incapsula"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := incapsula.NewSiemConnection(ctx, "exampleSiemConnectionS3Basic", &incapsula.SiemConnectionArgs{
			AccessKey:      pulumi.String("AKIAIOSFODNN7EXAMPLE"),
			AccountId:      pulumi.String("1234567"),
			ConnectionName: pulumi.String("APB siem-logs connection basic auth"),
			Path:           pulumi.String("myBucket/siem/logs"),
			SecretKey:      pulumi.String("wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"),
			StorageType:    pulumi.String("CUSTOMER_S3"),
		})
		if err != nil {
			return err
		}
		_, err = incapsula.NewSiemConnection(ctx, "exampleSiemConnectionS3Arn", &incapsula.SiemConnectionArgs{
			AccountId:      pulumi.String("1234567"),
			ConnectionName: pulumi.String("ABP siem-logs connection arn auth"),
			Path:           pulumi.String("myBucket/siem/logs"),
			StorageType:    pulumi.String("CUSTOMER_S3_ARN"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Incapsula = Pulumi.Incapsula;

return await Deployment.RunAsync(() => 
{
    var exampleSiemConnectionS3Basic = new Incapsula.SiemConnection("exampleSiemConnectionS3Basic", new()
    {
        AccessKey = "AKIAIOSFODNN7EXAMPLE",
        AccountId = "1234567",
        ConnectionName = "APB siem-logs connection basic auth",
        Path = "myBucket/siem/logs",
        SecretKey = "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
        StorageType = "CUSTOMER_S3",
    });

    var exampleSiemConnectionS3Arn = new Incapsula.SiemConnection("exampleSiemConnectionS3Arn", new()
    {
        AccountId = "1234567",
        ConnectionName = "ABP siem-logs connection arn auth",
        Path = "myBucket/siem/logs",
        StorageType = "CUSTOMER_S3_ARN",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.incapsula.SiemConnection;
import com.pulumi.incapsula.SiemConnectionArgs;
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 exampleSiemConnectionS3Basic = new SiemConnection("exampleSiemConnectionS3Basic", SiemConnectionArgs.builder()
            .accessKey("AKIAIOSFODNN7EXAMPLE")
            .accountId("1234567")
            .connectionName("APB siem-logs connection basic auth")
            .path("myBucket/siem/logs")
            .secretKey("wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY")
            .storageType("CUSTOMER_S3")
            .build());

        var exampleSiemConnectionS3Arn = new SiemConnection("exampleSiemConnectionS3Arn", SiemConnectionArgs.builder()
            .accountId("1234567")
            .connectionName("ABP siem-logs connection arn auth")
            .path("myBucket/siem/logs")
            .storageType("CUSTOMER_S3_ARN")
            .build());

    }
}
Copy
resources:
  exampleSiemConnectionS3Basic:
    type: incapsula:SiemConnection
    properties:
      accessKey: AKIAIOSFODNN7EXAMPLE
      accountId: '1234567'
      connectionName: APB siem-logs connection basic auth
      path: myBucket/siem/logs
      secretKey: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
      storageType: CUSTOMER_S3
  exampleSiemConnectionS3Arn:
    type: incapsula:SiemConnection
    properties:
      accountId: '1234567'
      connectionName: ABP siem-logs connection arn auth
      path: myBucket/siem/logs
      storageType: CUSTOMER_S3_ARN
Copy

NOTE: For security reasons, when a resource is exported, the access_key and secret_key fields will be replaced with the value Sensitive data placeholder. The actual key values are still used in the communication with the s3 bucket. Note - This resource cannot be updated unless you specify a real value for the access_key and secret_key fields instead of Sensitive data placeholder. To clarify, none of the fields in exported resources can be updated unless real access_key and secret_key values are set.

Example of exported resource:

import * as pulumi from "@pulumi/pulumi";
import * as incapsula from "@pulumi/incapsula";

const exampleSiemConnectionS3Basic = new incapsula.SiemConnection("exampleSiemConnectionS3Basic", {
    accessKey: "Sensitive data placeholder",
    accountId: "1234567",
    connectionName: "APB siem-logs connection basic auth",
    path: "myBucket/siem/logs",
    secretKey: "Sensitive data placeholder",
    storageType: "CUSTOMER_S3",
});
Copy
import pulumi
import pulumi_incapsula as incapsula

example_siem_connection_s3_basic = incapsula.SiemConnection("exampleSiemConnectionS3Basic",
    access_key="Sensitive data placeholder",
    account_id="1234567",
    connection_name="APB siem-logs connection basic auth",
    path="myBucket/siem/logs",
    secret_key="Sensitive data placeholder",
    storage_type="CUSTOMER_S3")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/incapsula/v3/incapsula"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := incapsula.NewSiemConnection(ctx, "exampleSiemConnectionS3Basic", &incapsula.SiemConnectionArgs{
			AccessKey:      pulumi.String("Sensitive data placeholder"),
			AccountId:      pulumi.String("1234567"),
			ConnectionName: pulumi.String("APB siem-logs connection basic auth"),
			Path:           pulumi.String("myBucket/siem/logs"),
			SecretKey:      pulumi.String("Sensitive data placeholder"),
			StorageType:    pulumi.String("CUSTOMER_S3"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Incapsula = Pulumi.Incapsula;

return await Deployment.RunAsync(() => 
{
    var exampleSiemConnectionS3Basic = new Incapsula.SiemConnection("exampleSiemConnectionS3Basic", new()
    {
        AccessKey = "Sensitive data placeholder",
        AccountId = "1234567",
        ConnectionName = "APB siem-logs connection basic auth",
        Path = "myBucket/siem/logs",
        SecretKey = "Sensitive data placeholder",
        StorageType = "CUSTOMER_S3",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.incapsula.SiemConnection;
import com.pulumi.incapsula.SiemConnectionArgs;
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 exampleSiemConnectionS3Basic = new SiemConnection("exampleSiemConnectionS3Basic", SiemConnectionArgs.builder()
            .accessKey("Sensitive data placeholder")
            .accountId("1234567")
            .connectionName("APB siem-logs connection basic auth")
            .path("myBucket/siem/logs")
            .secretKey("Sensitive data placeholder")
            .storageType("CUSTOMER_S3")
            .build());

    }
}
Copy
resources:
  exampleSiemConnectionS3Basic:
    type: incapsula:SiemConnection
    properties:
      accessKey: Sensitive data placeholder
      accountId: '1234567'
      connectionName: APB siem-logs connection basic auth
      path: myBucket/siem/logs
      secretKey: Sensitive data placeholder
      storageType: CUSTOMER_S3
Copy

Create SiemConnection Resource

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

Constructor syntax

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

@overload
def SiemConnection(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   connection_name: Optional[str] = None,
                   path: Optional[str] = None,
                   storage_type: Optional[str] = None,
                   access_key: Optional[str] = None,
                   account_id: Optional[str] = None,
                   input_hash: Optional[str] = None,
                   secret_key: Optional[str] = None,
                   siem_connection_id: Optional[str] = None)
func NewSiemConnection(ctx *Context, name string, args SiemConnectionArgs, opts ...ResourceOption) (*SiemConnection, error)
public SiemConnection(string name, SiemConnectionArgs args, CustomResourceOptions? opts = null)
public SiemConnection(String name, SiemConnectionArgs args)
public SiemConnection(String name, SiemConnectionArgs args, CustomResourceOptions options)

type: incapsula:SiemConnection
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. SiemConnectionArgs
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. SiemConnectionArgs
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. SiemConnectionArgs
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. SiemConnectionArgs
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. SiemConnectionArgs
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 siemConnectionResource = new Incapsula.SiemConnection("siemConnectionResource", new()
{
    ConnectionName = "string",
    Path = "string",
    StorageType = "string",
    AccessKey = "string",
    AccountId = "string",
    InputHash = "string",
    SecretKey = "string",
    SiemConnectionId = "string",
});
Copy
example, err := incapsula.NewSiemConnection(ctx, "siemConnectionResource", &incapsula.SiemConnectionArgs{
ConnectionName: pulumi.String("string"),
Path: pulumi.String("string"),
StorageType: pulumi.String("string"),
AccessKey: pulumi.String("string"),
AccountId: pulumi.String("string"),
InputHash: pulumi.String("string"),
SecretKey: pulumi.String("string"),
SiemConnectionId: pulumi.String("string"),
})
Copy
var siemConnectionResource = new SiemConnection("siemConnectionResource", SiemConnectionArgs.builder()
    .connectionName("string")
    .path("string")
    .storageType("string")
    .accessKey("string")
    .accountId("string")
    .inputHash("string")
    .secretKey("string")
    .siemConnectionId("string")
    .build());
Copy
siem_connection_resource = incapsula.SiemConnection("siemConnectionResource",
    connection_name="string",
    path="string",
    storage_type="string",
    access_key="string",
    account_id="string",
    input_hash="string",
    secret_key="string",
    siem_connection_id="string")
Copy
const siemConnectionResource = new incapsula.SiemConnection("siemConnectionResource", {
    connectionName: "string",
    path: "string",
    storageType: "string",
    accessKey: "string",
    accountId: "string",
    inputHash: "string",
    secretKey: "string",
    siemConnectionId: "string",
});
Copy
type: incapsula:SiemConnection
properties:
    accessKey: string
    accountId: string
    connectionName: string
    inputHash: string
    path: string
    secretKey: string
    siemConnectionId: string
    storageType: string
Copy

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

ConnectionName This property is required. string
Unique connection name.
Path This property is required. string
Path to the files inside bucket including bucket name: bucketName/folder/subfolder.
StorageType This property is required. string
Storage type. Possible values: CUSTOMER_S3, CUSTOMER_S3_ARN
AccessKey string
AWS access key.
AccountId string
The account to operate on. If not specified, operation will be performed on the account identified by the authentication parameters.
InputHash string
inputHash
SecretKey string
AWS access secret.
SiemConnectionId string
Unique identifier of the customer’s S3 connection.
ConnectionName This property is required. string
Unique connection name.
Path This property is required. string
Path to the files inside bucket including bucket name: bucketName/folder/subfolder.
StorageType This property is required. string
Storage type. Possible values: CUSTOMER_S3, CUSTOMER_S3_ARN
AccessKey string
AWS access key.
AccountId string
The account to operate on. If not specified, operation will be performed on the account identified by the authentication parameters.
InputHash string
inputHash
SecretKey string
AWS access secret.
SiemConnectionId string
Unique identifier of the customer’s S3 connection.
connectionName This property is required. String
Unique connection name.
path This property is required. String
Path to the files inside bucket including bucket name: bucketName/folder/subfolder.
storageType This property is required. String
Storage type. Possible values: CUSTOMER_S3, CUSTOMER_S3_ARN
accessKey String
AWS access key.
accountId String
The account to operate on. If not specified, operation will be performed on the account identified by the authentication parameters.
inputHash String
inputHash
secretKey String
AWS access secret.
siemConnectionId String
Unique identifier of the customer’s S3 connection.
connectionName This property is required. string
Unique connection name.
path This property is required. string
Path to the files inside bucket including bucket name: bucketName/folder/subfolder.
storageType This property is required. string
Storage type. Possible values: CUSTOMER_S3, CUSTOMER_S3_ARN
accessKey string
AWS access key.
accountId string
The account to operate on. If not specified, operation will be performed on the account identified by the authentication parameters.
inputHash string
inputHash
secretKey string
AWS access secret.
siemConnectionId string
Unique identifier of the customer’s S3 connection.
connection_name This property is required. str
Unique connection name.
path This property is required. str
Path to the files inside bucket including bucket name: bucketName/folder/subfolder.
storage_type This property is required. str
Storage type. Possible values: CUSTOMER_S3, CUSTOMER_S3_ARN
access_key str
AWS access key.
account_id str
The account to operate on. If not specified, operation will be performed on the account identified by the authentication parameters.
input_hash str
inputHash
secret_key str
AWS access secret.
siem_connection_id str
Unique identifier of the customer’s S3 connection.
connectionName This property is required. String
Unique connection name.
path This property is required. String
Path to the files inside bucket including bucket name: bucketName/folder/subfolder.
storageType This property is required. String
Storage type. Possible values: CUSTOMER_S3, CUSTOMER_S3_ARN
accessKey String
AWS access key.
accountId String
The account to operate on. If not specified, operation will be performed on the account identified by the authentication parameters.
inputHash String
inputHash
secretKey String
AWS access secret.
siemConnectionId String
Unique identifier of the customer’s S3 connection.

Outputs

All input properties are implicitly available as output properties. Additionally, the SiemConnection 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 SiemConnection Resource

Get an existing SiemConnection 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?: SiemConnectionState, opts?: CustomResourceOptions): SiemConnection
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_key: Optional[str] = None,
        account_id: Optional[str] = None,
        connection_name: Optional[str] = None,
        input_hash: Optional[str] = None,
        path: Optional[str] = None,
        secret_key: Optional[str] = None,
        siem_connection_id: Optional[str] = None,
        storage_type: Optional[str] = None) -> SiemConnection
func GetSiemConnection(ctx *Context, name string, id IDInput, state *SiemConnectionState, opts ...ResourceOption) (*SiemConnection, error)
public static SiemConnection Get(string name, Input<string> id, SiemConnectionState? state, CustomResourceOptions? opts = null)
public static SiemConnection get(String name, Output<String> id, SiemConnectionState state, CustomResourceOptions options)
resources:  _:    type: incapsula:SiemConnection    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:
AccessKey string
AWS access key.
AccountId string
The account to operate on. If not specified, operation will be performed on the account identified by the authentication parameters.
ConnectionName string
Unique connection name.
InputHash string
inputHash
Path string
Path to the files inside bucket including bucket name: bucketName/folder/subfolder.
SecretKey string
AWS access secret.
SiemConnectionId string
Unique identifier of the customer’s S3 connection.
StorageType string
Storage type. Possible values: CUSTOMER_S3, CUSTOMER_S3_ARN
AccessKey string
AWS access key.
AccountId string
The account to operate on. If not specified, operation will be performed on the account identified by the authentication parameters.
ConnectionName string
Unique connection name.
InputHash string
inputHash
Path string
Path to the files inside bucket including bucket name: bucketName/folder/subfolder.
SecretKey string
AWS access secret.
SiemConnectionId string
Unique identifier of the customer’s S3 connection.
StorageType string
Storage type. Possible values: CUSTOMER_S3, CUSTOMER_S3_ARN
accessKey String
AWS access key.
accountId String
The account to operate on. If not specified, operation will be performed on the account identified by the authentication parameters.
connectionName String
Unique connection name.
inputHash String
inputHash
path String
Path to the files inside bucket including bucket name: bucketName/folder/subfolder.
secretKey String
AWS access secret.
siemConnectionId String
Unique identifier of the customer’s S3 connection.
storageType String
Storage type. Possible values: CUSTOMER_S3, CUSTOMER_S3_ARN
accessKey string
AWS access key.
accountId string
The account to operate on. If not specified, operation will be performed on the account identified by the authentication parameters.
connectionName string
Unique connection name.
inputHash string
inputHash
path string
Path to the files inside bucket including bucket name: bucketName/folder/subfolder.
secretKey string
AWS access secret.
siemConnectionId string
Unique identifier of the customer’s S3 connection.
storageType string
Storage type. Possible values: CUSTOMER_S3, CUSTOMER_S3_ARN
access_key str
AWS access key.
account_id str
The account to operate on. If not specified, operation will be performed on the account identified by the authentication parameters.
connection_name str
Unique connection name.
input_hash str
inputHash
path str
Path to the files inside bucket including bucket name: bucketName/folder/subfolder.
secret_key str
AWS access secret.
siem_connection_id str
Unique identifier of the customer’s S3 connection.
storage_type str
Storage type. Possible values: CUSTOMER_S3, CUSTOMER_S3_ARN
accessKey String
AWS access key.
accountId String
The account to operate on. If not specified, operation will be performed on the account identified by the authentication parameters.
connectionName String
Unique connection name.
inputHash String
inputHash
path String
Path to the files inside bucket including bucket name: bucketName/folder/subfolder.
secretKey String
AWS access secret.
siemConnectionId String
Unique identifier of the customer’s S3 connection.
storageType String
Storage type. Possible values: CUSTOMER_S3, CUSTOMER_S3_ARN

Import

Customer connection can be imported using accountId/connectionId:

$ pulumi import incapsula:index/siemConnection:SiemConnection example_siem_connection accountId/connectionId
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
incapsula imperva/terraform-provider-incapsula
License
Notes
This Pulumi package is based on the incapsula Terraform Provider.
incapsula 3.32.1 published on Monday, Apr 14, 2025 by imperva
imperva/terraform-provider-incapsula