Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Incapsula Provider
  3. API Docs
  4. SiemSftpConnection
incapsula 3.33.0 published on Wednesday, Apr 30, 2025 by imperva
imperva/terraform-provider-incapsula

incapsula.SiemSftpConnection

Explore with Pulumi AI

incapsula logo
incapsula 3.33.0 published on Wednesday, Apr 30, 2025 by imperva
imperva/terraform-provider-incapsula

    Provides a customer SFTP 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 exampleSiemSftpConnection = new incapsula.SiemSftpConnection("exampleSiemSftpConnection", {
    accountId: "1234567",
    connectionName: "ABP siem-logs SFTP connection",
    host: "ec2.eu-west-2.compute.amazonaws.com",
    password: "Sensitive data placeholder",
    path: "/example/accounts/1234567",
    username: "example_sftp_user",
});

    import pulumi
import pulumi_incapsula as incapsula

example_siem_sftp_connection = incapsula.SiemSftpConnection("exampleSiemSftpConnection",
    account_id="1234567",
    connection_name="ABP siem-logs SFTP connection",
    host="ec2.eu-west-2.compute.amazonaws.com",
    password="Sensitive data placeholder",
    path="/example/accounts/1234567",
    username="example_sftp_user")

    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.NewSiemSftpConnection(ctx, "exampleSiemSftpConnection", &incapsula.SiemSftpConnectionArgs{
			AccountId:      pulumi.String("1234567"),
			ConnectionName: pulumi.String("ABP siem-logs SFTP connection"),
			Host:           pulumi.String("ec2.eu-west-2.compute.amazonaws.com"),
			Password:       pulumi.String("Sensitive data placeholder"),
			Path:           pulumi.String("/example/accounts/1234567"),
			Username:       pulumi.String("example_sftp_user"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Incapsula = Pulumi.Incapsula;

return await Deployment.RunAsync(() => 
{
    var exampleSiemSftpConnection = new Incapsula.SiemSftpConnection("exampleSiemSftpConnection", new()
    {
        AccountId = "1234567",
        ConnectionName = "ABP siem-logs SFTP connection",
        Host = "ec2.eu-west-2.compute.amazonaws.com",
        Password = "Sensitive data placeholder",
        Path = "/example/accounts/1234567",
        Username = "example_sftp_user",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.incapsula.SiemSftpConnection;
import com.pulumi.incapsula.SiemSftpConnectionArgs;
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 exampleSiemSftpConnection = new SiemSftpConnection("exampleSiemSftpConnection", SiemSftpConnectionArgs.builder()
            .accountId("1234567")
            .connectionName("ABP siem-logs SFTP connection")
            .host("ec2.eu-west-2.compute.amazonaws.com")
            .password("Sensitive data placeholder")
            .path("/example/accounts/1234567")
            .username("example_sftp_user")
            .build());

    }
}

    resources:
  exampleSiemSftpConnection:
    type: incapsula:SiemSftpConnection
    properties:
      accountId: '1234567'
      connectionName: ABP siem-logs SFTP connection
      host: ec2.eu-west-2.compute.amazonaws.com
      password: Sensitive data placeholder
      path: /example/accounts/1234567
      username: example_sftp_user

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

    Example of exported resource:

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

const exampleSiemSftpConnection = new incapsula.SiemSftpConnection("exampleSiemSftpConnection", {
    accountId: "1234567",
    connectionName: "APB siem-logs SFTP connection",
    host: "ec2.eu-west-2.compute.amazonaws.com",
    password: "Sensitive data placeholder",
    path: "/example/accounts/1234567",
    username: "example_sftp_user",
});

    import pulumi
import pulumi_incapsula as incapsula

example_siem_sftp_connection = incapsula.SiemSftpConnection("exampleSiemSftpConnection",
    account_id="1234567",
    connection_name="APB siem-logs SFTP connection",
    host="ec2.eu-west-2.compute.amazonaws.com",
    password="Sensitive data placeholder",
    path="/example/accounts/1234567",
    username="example_sftp_user")

    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.NewSiemSftpConnection(ctx, "exampleSiemSftpConnection", &incapsula.SiemSftpConnectionArgs{
			AccountId:      pulumi.String("1234567"),
			ConnectionName: pulumi.String("APB siem-logs SFTP connection"),
			Host:           pulumi.String("ec2.eu-west-2.compute.amazonaws.com"),
			Password:       pulumi.String("Sensitive data placeholder"),
			Path:           pulumi.String("/example/accounts/1234567"),
			Username:       pulumi.String("example_sftp_user"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Incapsula = Pulumi.Incapsula;

return await Deployment.RunAsync(() => 
{
    var exampleSiemSftpConnection = new Incapsula.SiemSftpConnection("exampleSiemSftpConnection", new()
    {
        AccountId = "1234567",
        ConnectionName = "APB siem-logs SFTP connection",
        Host = "ec2.eu-west-2.compute.amazonaws.com",
        Password = "Sensitive data placeholder",
        Path = "/example/accounts/1234567",
        Username = "example_sftp_user",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.incapsula.SiemSftpConnection;
import com.pulumi.incapsula.SiemSftpConnectionArgs;
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 exampleSiemSftpConnection = new SiemSftpConnection("exampleSiemSftpConnection", SiemSftpConnectionArgs.builder()
            .accountId("1234567")
            .connectionName("APB siem-logs SFTP connection")
            .host("ec2.eu-west-2.compute.amazonaws.com")
            .password("Sensitive data placeholder")
            .path("/example/accounts/1234567")
            .username("example_sftp_user")
            .build());

    }
}

    resources:
  exampleSiemSftpConnection:
    type: incapsula:SiemSftpConnection
    properties:
      accountId: '1234567'
      connectionName: APB siem-logs SFTP connection
      host: ec2.eu-west-2.compute.amazonaws.com
      password: Sensitive data placeholder
      path: /example/accounts/1234567
      username: example_sftp_user

    Create SiemSftpConnection Resource

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

    Constructor syntax

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

@overload
def SiemSftpConnection(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       connection_name: Optional[str] = None,
                       host: Optional[str] = None,
                       path: Optional[str] = None,
                       username: Optional[str] = None,
                       account_id: Optional[str] = None,
                       input_hash: Optional[str] = None,
                       password: Optional[str] = None,
                       siem_sftp_connection_id: Optional[str] = None)
    func NewSiemSftpConnection(ctx *Context, name string, args SiemSftpConnectionArgs, opts ...ResourceOption) (*SiemSftpConnection, error)
    public SiemSftpConnection(string name, SiemSftpConnectionArgs args, CustomResourceOptions? opts = null)
    public SiemSftpConnection(String name, SiemSftpConnectionArgs args)
public SiemSftpConnection(String name, SiemSftpConnectionArgs args, CustomResourceOptions options)

    type: incapsula:SiemSftpConnection
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 SiemSftpConnectionArgs
    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 SiemSftpConnectionArgs
    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 SiemSftpConnectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SiemSftpConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SiemSftpConnectionArgs
    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 siemSftpConnectionResource = new Incapsula.SiemSftpConnection("siemSftpConnectionResource", new()
{
    ConnectionName = "string",
    Host = "string",
    Path = "string",
    Username = "string",
    AccountId = "string",
    InputHash = "string",
    Password = "string",
    SiemSftpConnectionId = "string",
});

    example, err := incapsula.NewSiemSftpConnection(ctx, "siemSftpConnectionResource", &incapsula.SiemSftpConnectionArgs{
	ConnectionName:       pulumi.String("string"),
	Host:                 pulumi.String("string"),
	Path:                 pulumi.String("string"),
	Username:             pulumi.String("string"),
	AccountId:            pulumi.String("string"),
	InputHash:            pulumi.String("string"),
	Password:             pulumi.String("string"),
	SiemSftpConnectionId: pulumi.String("string"),
})

    var siemSftpConnectionResource = new SiemSftpConnection("siemSftpConnectionResource", SiemSftpConnectionArgs.builder()
    .connectionName("string")
    .host("string")
    .path("string")
    .username("string")
    .accountId("string")
    .inputHash("string")
    .password("string")
    .siemSftpConnectionId("string")
    .build());

    siem_sftp_connection_resource = incapsula.SiemSftpConnection("siemSftpConnectionResource",
    connection_name="string",
    host="string",
    path="string",
    username="string",
    account_id="string",
    input_hash="string",
    password="string",
    siem_sftp_connection_id="string")

    const siemSftpConnectionResource = new incapsula.SiemSftpConnection("siemSftpConnectionResource", {
    connectionName: "string",
    host: "string",
    path: "string",
    username: "string",
    accountId: "string",
    inputHash: "string",
    password: "string",
    siemSftpConnectionId: "string",
});

    type: incapsula:SiemSftpConnection
properties:
    accountId: string
    connectionName: string
    host: string
    inputHash: string
    password: string
    path: string
    siemSftpConnectionId: string
    username: string

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

    ConnectionName string
    Unique connection name.
    Host string
    SFTP server host.
    Path string
    SFTP server path.
    Username string
    SFTP access username.
    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
    Password string
    SFTP access password.
    SiemSftpConnectionId string
    Unique identifier of the customer’s SFTP connection.
    ConnectionName string
    Unique connection name.
    Host string
    SFTP server host.
    Path string
    SFTP server path.
    Username string
    SFTP access username.
    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
    Password string
    SFTP access password.
    SiemSftpConnectionId string
    Unique identifier of the customer’s SFTP connection.
    connectionName String
    Unique connection name.
    host String
    SFTP server host.
    path String
    SFTP server path.
    username String
    SFTP access username.
    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
    password String
    SFTP access password.
    siemSftpConnectionId String
    Unique identifier of the customer’s SFTP connection.
    connectionName string
    Unique connection name.
    host string
    SFTP server host.
    path string
    SFTP server path.
    username string
    SFTP access username.
    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
    password string
    SFTP access password.
    siemSftpConnectionId string
    Unique identifier of the customer’s SFTP connection.
    connection_name str
    Unique connection name.
    host str
    SFTP server host.
    path str
    SFTP server path.
    username str
    SFTP access username.
    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
    password str
    SFTP access password.
    siem_sftp_connection_id str
    Unique identifier of the customer’s SFTP connection.
    connectionName String
    Unique connection name.
    host String
    SFTP server host.
    path String
    SFTP server path.
    username String
    SFTP access username.
    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
    password String
    SFTP access password.
    siemSftpConnectionId String
    Unique identifier of the customer’s SFTP connection.

    Outputs

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

    Get an existing SiemSftpConnection 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?: SiemSftpConnectionState, opts?: CustomResourceOptions): SiemSftpConnection
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        connection_name: Optional[str] = None,
        host: Optional[str] = None,
        input_hash: Optional[str] = None,
        password: Optional[str] = None,
        path: Optional[str] = None,
        siem_sftp_connection_id: Optional[str] = None,
        username: Optional[str] = None) -> SiemSftpConnection
    func GetSiemSftpConnection(ctx *Context, name string, id IDInput, state *SiemSftpConnectionState, opts ...ResourceOption) (*SiemSftpConnection, error)
    public static SiemSftpConnection Get(string name, Input<string> id, SiemSftpConnectionState? state, CustomResourceOptions? opts = null)
    public static SiemSftpConnection get(String name, Output<String> id, SiemSftpConnectionState state, CustomResourceOptions options)
    resources:  _:    type: incapsula:SiemSftpConnection    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:
    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.
    Host string
    SFTP server host.
    InputHash string
    inputHash
    Password string
    SFTP access password.
    Path string
    SFTP server path.
    SiemSftpConnectionId string
    Unique identifier of the customer’s SFTP connection.
    Username string
    SFTP access username.
    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.
    Host string
    SFTP server host.
    InputHash string
    inputHash
    Password string
    SFTP access password.
    Path string
    SFTP server path.
    SiemSftpConnectionId string
    Unique identifier of the customer’s SFTP connection.
    Username string
    SFTP access username.
    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.
    host String
    SFTP server host.
    inputHash String
    inputHash
    password String
    SFTP access password.
    path String
    SFTP server path.
    siemSftpConnectionId String
    Unique identifier of the customer’s SFTP connection.
    username String
    SFTP access username.
    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.
    host string
    SFTP server host.
    inputHash string
    inputHash
    password string
    SFTP access password.
    path string
    SFTP server path.
    siemSftpConnectionId string
    Unique identifier of the customer’s SFTP connection.
    username string
    SFTP access username.
    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.
    host str
    SFTP server host.
    input_hash str
    inputHash
    password str
    SFTP access password.
    path str
    SFTP server path.
    siem_sftp_connection_id str
    Unique identifier of the customer’s SFTP connection.
    username str
    SFTP access username.
    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.
    host String
    SFTP server host.
    inputHash String
    inputHash
    password String
    SFTP access password.
    path String
    SFTP server path.
    siemSftpConnectionId String
    Unique identifier of the customer’s SFTP connection.
    username String
    SFTP access username.

    Import

    Customer connection can be imported using accountId/connectionId:

    $ pulumi import incapsula:index/siemSftpConnection:SiemSftpConnection example_siem_sftp_connection accountId/connectionId

    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 logo
    incapsula 3.33.0 published on Wednesday, Apr 30, 2025 by imperva
    imperva/terraform-provider-incapsula