airbyte 0.7.0-beta2, Mar 7 25

airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq

airbyte.SourceSftp

Explore with Pulumi AI

airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.airbyte.SourceSftp;
import com.pulumi.airbyte.SourceSftpArgs;
import com.pulumi.airbyte.inputs.SourceSftpConfigurationArgs;
import com.pulumi.airbyte.inputs.SourceSftpConfigurationCredentialsArgs;
import com.pulumi.airbyte.inputs.SourceSftpConfigurationCredentialsPasswordAuthenticationArgs;
import com.pulumi.airbyte.inputs.SourceSftpConfigurationCredentialsSshKeyAuthenticationArgs;
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 mySourceSftp = new SourceSftp("mySourceSftp", SourceSftpArgs.builder()
            .configuration(SourceSftpConfigurationArgs.builder()
                .credentials(SourceSftpConfigurationCredentialsArgs.builder()
                    .passwordAuthentication(SourceSftpConfigurationCredentialsPasswordAuthenticationArgs.builder()
                        .authUserPassword("...my_auth_user_password...")
                        .build())
                    .sshKeyAuthentication(SourceSftpConfigurationCredentialsSshKeyAuthenticationArgs.builder()
                        .authSshKey("...my_auth_ssh_key...")
                        .build())
                    .build())
                .file_pattern("log-([0-9]{4})([0-9]{2})([0-9]{2}) - This will filter files which  `log-yearmmdd`")
                .file_types("csv,json")
                .folder_path("/logs/2022")
                .host("www.host.com")
                .port(22)
                .user("...my_user...")
                .build())
            .definitionId("ef03926e-13cb-4929-aa6b-e7c8e1b0c80e")
            .secretId("...my_secret_id...")
            .workspaceId("de2e80b4-0898-4bea-821b-cb0c33f06888")
            .build());

    }
}

resources:
  mySourceSftp:
    type: airbyte:SourceSftp
    properties:
      configuration:
        credentials:
          passwordAuthentication:
            authUserPassword: '...my_auth_user_password...'
          sshKeyAuthentication:
            authSshKey: '...my_auth_ssh_key...'
        file_pattern: log-([0-9]{4})([0-9]{2})([0-9]{2}) - This will filter files which  `log-yearmmdd`
        file_types: csv,json
        folder_path: /logs/2022
        host: www.host.com
        port: 22
        user: '...my_user...'
      definitionId: ef03926e-13cb-4929-aa6b-e7c8e1b0c80e
      secretId: '...my_secret_id...'
      workspaceId: de2e80b4-0898-4bea-821b-cb0c33f06888

Create SourceSftp Resource

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

Constructor syntax

new SourceSftp(name: string, args: SourceSftpArgs, opts?: CustomResourceOptions);

@overload
def SourceSftp(resource_name: str,
               args: SourceSftpArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def SourceSftp(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               configuration: Optional[SourceSftpConfigurationArgs] = None,
               workspace_id: Optional[str] = None,
               definition_id: Optional[str] = None,
               name: Optional[str] = None,
               secret_id: Optional[str] = None)

func NewSourceSftp(ctx *Context, name string, args SourceSftpArgs, opts ...ResourceOption) (*SourceSftp, error)

public SourceSftp(string name, SourceSftpArgs args, CustomResourceOptions? opts = null)

public SourceSftp(String name, SourceSftpArgs args)
public SourceSftp(String name, SourceSftpArgs args, CustomResourceOptions options)

type: airbyte:SourceSftp
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 SourceSftpArgs: 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 SourceSftpArgs: 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 SourceSftpArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args SourceSftpArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args SourceSftpArgs: 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 sourceSftpResource = new Airbyte.SourceSftp("sourceSftpResource", new()
{
    Configuration = new Airbyte.Inputs.SourceSftpConfigurationArgs
    {
        Host = "string",
        User = "string",
        Credentials = new Airbyte.Inputs.SourceSftpConfigurationCredentialsArgs
        {
            PasswordAuthentication = new Airbyte.Inputs.SourceSftpConfigurationCredentialsPasswordAuthenticationArgs
            {
                AuthUserPassword = "string",
            },
            SshKeyAuthentication = new Airbyte.Inputs.SourceSftpConfigurationCredentialsSshKeyAuthenticationArgs
            {
                AuthSshKey = "string",
            },
        },
        FilePattern = "string",
        FileTypes = "string",
        FolderPath = "string",
        Port = 0,
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});

example, err := airbyte.NewSourceSftp(ctx, "sourceSftpResource", &airbyte.SourceSftpArgs{
Configuration: &.SourceSftpConfigurationArgs{
Host: pulumi.String("string"),
User: pulumi.String("string"),
Credentials: &.SourceSftpConfigurationCredentialsArgs{
PasswordAuthentication: &.SourceSftpConfigurationCredentialsPasswordAuthenticationArgs{
AuthUserPassword: pulumi.String("string"),
},
SshKeyAuthentication: &.SourceSftpConfigurationCredentialsSshKeyAuthenticationArgs{
AuthSshKey: pulumi.String("string"),
},
},
FilePattern: pulumi.String("string"),
FileTypes: pulumi.String("string"),
FolderPath: pulumi.String("string"),
Port: pulumi.Float64(0),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})

var sourceSftpResource = new SourceSftp("sourceSftpResource", SourceSftpArgs.builder()
    .configuration(SourceSftpConfigurationArgs.builder()
        .host("string")
        .user("string")
        .credentials(SourceSftpConfigurationCredentialsArgs.builder()
            .passwordAuthentication(SourceSftpConfigurationCredentialsPasswordAuthenticationArgs.builder()
                .authUserPassword("string")
                .build())
            .sshKeyAuthentication(SourceSftpConfigurationCredentialsSshKeyAuthenticationArgs.builder()
                .authSshKey("string")
                .build())
            .build())
        .filePattern("string")
        .fileTypes("string")
        .folderPath("string")
        .port(0)
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());

source_sftp_resource = airbyte.SourceSftp("sourceSftpResource",
    configuration={
        "host": "string",
        "user": "string",
        "credentials": {
            "password_authentication": {
                "auth_user_password": "string",
            },
            "ssh_key_authentication": {
                "auth_ssh_key": "string",
            },
        },
        "file_pattern": "string",
        "file_types": "string",
        "folder_path": "string",
        "port": 0,
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")

const sourceSftpResource = new airbyte.SourceSftp("sourceSftpResource", {
    configuration: {
        host: "string",
        user: "string",
        credentials: {
            passwordAuthentication: {
                authUserPassword: "string",
            },
            sshKeyAuthentication: {
                authSshKey: "string",
            },
        },
        filePattern: "string",
        fileTypes: "string",
        folderPath: "string",
        port: 0,
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});

type: airbyte:SourceSftp
properties:
    configuration:
        credentials:
            passwordAuthentication:
                authUserPassword: string
            sshKeyAuthentication:
                authSshKey: string
        filePattern: string
        fileTypes: string
        folderPath: string
        host: string
        port: 0
        user: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string

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

Configuration SourceSftpConfiguration
WorkspaceId string
DefinitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string: Name of the source e.g. dev-mysql-instance.
SecretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

Configuration SourceSftpConfigurationArgs
WorkspaceId string
DefinitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string: Name of the source e.g. dev-mysql-instance.
SecretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration SourceSftpConfiguration
workspaceId String
definitionId String: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String: Name of the source e.g. dev-mysql-instance.
secretId String: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration SourceSftpConfiguration
workspaceId string
definitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name string: Name of the source e.g. dev-mysql-instance.
secretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration SourceSftpConfigurationArgs
workspace_id str
definition_id str: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name str: Name of the source e.g. dev-mysql-instance.
secret_id str: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration Property Map
workspaceId String
definitionId String: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String: Name of the source e.g. dev-mysql-instance.
secretId String: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

Outputs

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

CreatedAt double
Id string: The provider-assigned unique ID for this managed resource.
SourceId string
SourceType string

CreatedAt float64
Id string: The provider-assigned unique ID for this managed resource.
SourceId string
SourceType string

createdAt Double
id String: The provider-assigned unique ID for this managed resource.
sourceId String
sourceType String

createdAt number
id string: The provider-assigned unique ID for this managed resource.
sourceId string
sourceType string

created_at float
id str: The provider-assigned unique ID for this managed resource.
source_id str
source_type str

createdAt Number
id String: The provider-assigned unique ID for this managed resource.
sourceId String
sourceType String

Look up Existing SourceSftp Resource

Get an existing SourceSftp 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?: SourceSftpState, opts?: CustomResourceOptions): SourceSftp

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourceSftpConfigurationArgs] = None,
        created_at: Optional[float] = None,
        definition_id: Optional[str] = None,
        name: Optional[str] = None,
        secret_id: Optional[str] = None,
        source_id: Optional[str] = None,
        source_type: Optional[str] = None,
        workspace_id: Optional[str] = None) -> SourceSftp

func GetSourceSftp(ctx *Context, name string, id IDInput, state *SourceSftpState, opts ...ResourceOption) (*SourceSftp, error)

public static SourceSftp Get(string name, Input<string> id, SourceSftpState? state, CustomResourceOptions? opts = null)

public static SourceSftp get(String name, Output<String> id, SourceSftpState state, CustomResourceOptions options)

resources:  _:    type: airbyte:SourceSftp    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:

Configuration SourceSftpConfiguration
CreatedAt double
DefinitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string: Name of the source e.g. dev-mysql-instance.
SecretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
SourceId string
SourceType string
WorkspaceId string

Configuration SourceSftpConfigurationArgs
CreatedAt float64
DefinitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string: Name of the source e.g. dev-mysql-instance.
SecretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
SourceId string
SourceType string
WorkspaceId string

configuration SourceSftpConfiguration
createdAt Double
definitionId String: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String: Name of the source e.g. dev-mysql-instance.
secretId String: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId String
sourceType String
workspaceId String

configuration SourceSftpConfiguration
createdAt number
definitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name string: Name of the source e.g. dev-mysql-instance.
secretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId string
sourceType string
workspaceId string

configuration SourceSftpConfigurationArgs
created_at float
definition_id str: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name str: Name of the source e.g. dev-mysql-instance.
secret_id str: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
source_id str
source_type str
workspace_id str

configuration Property Map
createdAt Number
definitionId String: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String: Name of the source e.g. dev-mysql-instance.
secretId String: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId String
sourceType String
workspaceId String

Supporting Types

SourceSftpConfiguration, SourceSftpConfigurationArgs

Host string: The server host address
User string: The server user
Credentials SourceSftpConfigurationCredentials: The server authentication method
FilePattern string: The regular expression to specify files for sync in a chosen Folder Path. Default: ""
FileTypes string: Coma separated file types. Currently only 'csv' and 'json' types are supported. Default: "csv,json"
FolderPath string: The directory to search files for sync. Default: ""
Port double: The server port. Default: 22

Host string: The server host address
User string: The server user
Credentials SourceSftpConfigurationCredentials: The server authentication method
FilePattern string: The regular expression to specify files for sync in a chosen Folder Path. Default: ""
FileTypes string: Coma separated file types. Currently only 'csv' and 'json' types are supported. Default: "csv,json"
FolderPath string: The directory to search files for sync. Default: ""
Port float64: The server port. Default: 22

host String: The server host address
user String: The server user
credentials SourceSftpConfigurationCredentials: The server authentication method
filePattern String: The regular expression to specify files for sync in a chosen Folder Path. Default: ""
fileTypes String: Coma separated file types. Currently only 'csv' and 'json' types are supported. Default: "csv,json"
folderPath String: The directory to search files for sync. Default: ""
port Double: The server port. Default: 22

host string: The server host address
user string: The server user
credentials SourceSftpConfigurationCredentials: The server authentication method
filePattern string: The regular expression to specify files for sync in a chosen Folder Path. Default: ""
fileTypes string: Coma separated file types. Currently only 'csv' and 'json' types are supported. Default: "csv,json"
folderPath string: The directory to search files for sync. Default: ""
port number: The server port. Default: 22

host str: The server host address
user str: The server user
credentials SourceSftpConfigurationCredentials: The server authentication method
file_pattern str: The regular expression to specify files for sync in a chosen Folder Path. Default: ""
file_types str: Coma separated file types. Currently only 'csv' and 'json' types are supported. Default: "csv,json"
folder_path str: The directory to search files for sync. Default: ""
port float: The server port. Default: 22

host String: The server host address
user String: The server user
credentials Property Map: The server authentication method
filePattern String: The regular expression to specify files for sync in a chosen Folder Path. Default: ""
fileTypes String: Coma separated file types. Currently only 'csv' and 'json' types are supported. Default: "csv,json"
folderPath String: The directory to search files for sync. Default: ""
port Number: The server port. Default: 22

SourceSftpConfigurationCredentials, SourceSftpConfigurationCredentialsArgs

PasswordAuthentication SourceSftpConfigurationCredentialsPasswordAuthentication
SshKeyAuthentication SourceSftpConfigurationCredentialsSshKeyAuthentication

PasswordAuthentication SourceSftpConfigurationCredentialsPasswordAuthentication
SshKeyAuthentication SourceSftpConfigurationCredentialsSshKeyAuthentication

passwordAuthentication SourceSftpConfigurationCredentialsPasswordAuthentication
sshKeyAuthentication SourceSftpConfigurationCredentialsSshKeyAuthentication

passwordAuthentication SourceSftpConfigurationCredentialsPasswordAuthentication
sshKeyAuthentication SourceSftpConfigurationCredentialsSshKeyAuthentication

password_authentication SourceSftpConfigurationCredentialsPasswordAuthentication
ssh_key_authentication SourceSftpConfigurationCredentialsSshKeyAuthentication

passwordAuthentication Property Map
sshKeyAuthentication Property Map

SourceSftpConfigurationCredentialsPasswordAuthentication, SourceSftpConfigurationCredentialsPasswordAuthenticationArgs

AuthUserPassword string: OS-level password for logging into the jump server host

AuthUserPassword string: OS-level password for logging into the jump server host

authUserPassword String: OS-level password for logging into the jump server host

authUserPassword string: OS-level password for logging into the jump server host

auth_user_password str: OS-level password for logging into the jump server host

authUserPassword String: OS-level password for logging into the jump server host

SourceSftpConfigurationCredentialsSshKeyAuthentication, SourceSftpConfigurationCredentialsSshKeyAuthenticationArgs

AuthSshKey string: OS-level user account ssh key credentials in RSA PEM format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )

AuthSshKey string: OS-level user account ssh key credentials in RSA PEM format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )

authSshKey String: OS-level user account ssh key credentials in RSA PEM format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )

authSshKey string: OS-level user account ssh key credentials in RSA PEM format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )

auth_ssh_key str: OS-level user account ssh key credentials in RSA PEM format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )

authSshKey String: OS-level user account ssh key credentials in RSA PEM format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )

Import

$ pulumi import airbyte:index/sourceSftp:SourceSftp my_airbyte_source_sftp ""

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

Package Details

Repository: airbyte airbytehq/terraform-provider-airbyte
License
Notes: This Pulumi package is based on the airbyte Terraform Provider.

airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq

airbytehq/terraform-provider-airbyte

airbyte.SourceSftp

On this page

On this page

Example Usage

Create SourceSftp Resource

Constructor syntax

Parameters

Constructor example

SourceSftp Resource Properties

Inputs

Outputs

Look up Existing SourceSftp Resource

Supporting Types

SourceSftpConfiguration, SourceSftpConfigurationArgs

SourceSftpConfigurationCredentials, SourceSftpConfigurationCredentialsArgs

SourceSftpConfigurationCredentialsPasswordAuthentication, SourceSftpConfigurationCredentialsPasswordAuthenticationArgs

SourceSftpConfigurationCredentialsSshKeyAuthentication, SourceSftpConfigurationCredentialsSshKeyAuthenticationArgs

Import

Package Details

On this page

On this page