airbyte 0.8.0-beta2, Mar 27 25

airbyte 0.8.0-beta2 published on Thursday, Mar 27, 2025 by airbytehq

airbyte.DestinationSftpJson

Explore with Pulumi AI

airbyte 0.8.0-beta2 published on Thursday, Mar 27, 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.DestinationSftpJson;
import com.pulumi.airbyte.DestinationSftpJsonArgs;
import com.pulumi.airbyte.inputs.DestinationSftpJsonConfigurationArgs;
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 myDestinationSftpjson = new DestinationSftpJson("myDestinationSftpjson", DestinationSftpJsonArgs.builder()
            .configuration(DestinationSftpJsonConfigurationArgs.builder()
                .destination_path("/json_data")
                .host("...my_host...")
                .password("...my_password...")
                .port(22)
                .username("...my_username...")
                .build())
            .definitionId("0c8fa949-f25a-4a4d-a64e-1f825a21e3bd")
            .workspaceId("ab73fdf5-b478-44fc-996e-1ac739d8b9d4")
            .build());

    }
}

resources:
  myDestinationSftpjson:
    type: airbyte:DestinationSftpJson
    properties:
      configuration:
        destination_path: /json_data
        host: '...my_host...'
        password: '...my_password...'
        port: 22
        username: '...my_username...'
      definitionId: 0c8fa949-f25a-4a4d-a64e-1f825a21e3bd
      workspaceId: ab73fdf5-b478-44fc-996e-1ac739d8b9d4

Create DestinationSftpJson Resource

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

Constructor syntax

new DestinationSftpJson(name: string, args: DestinationSftpJsonArgs, opts?: CustomResourceOptions);

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

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

func NewDestinationSftpJson(ctx *Context, name string, args DestinationSftpJsonArgs, opts ...ResourceOption) (*DestinationSftpJson, error)

public DestinationSftpJson(string name, DestinationSftpJsonArgs args, CustomResourceOptions? opts = null)

public DestinationSftpJson(String name, DestinationSftpJsonArgs args)
public DestinationSftpJson(String name, DestinationSftpJsonArgs args, CustomResourceOptions options)

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

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

name String: The unique name of the resource.
args DestinationSftpJsonArgs: 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 destinationSftpJsonResource = new Airbyte.DestinationSftpJson("destinationSftpJsonResource", new()
{
    Configuration = new Airbyte.Inputs.DestinationSftpJsonConfigurationArgs
    {
        DestinationPath = "string",
        Host = "string",
        Password = "string",
        Username = "string",
        Port = 0,
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
});

example, err := airbyte.NewDestinationSftpJson(ctx, "destinationSftpJsonResource", &airbyte.DestinationSftpJsonArgs{
Configuration: &.DestinationSftpJsonConfigurationArgs{
DestinationPath: pulumi.String("string"),
Host: pulumi.String("string"),
Password: pulumi.String("string"),
Username: pulumi.String("string"),
Port: pulumi.Float64(0),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
})

var destinationSftpJsonResource = new DestinationSftpJson("destinationSftpJsonResource", DestinationSftpJsonArgs.builder()
    .configuration(DestinationSftpJsonConfigurationArgs.builder()
        .destinationPath("string")
        .host("string")
        .password("string")
        .username("string")
        .port(0)
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .build());

destination_sftp_json_resource = airbyte.DestinationSftpJson("destinationSftpJsonResource",
    configuration={
        "destination_path": "string",
        "host": "string",
        "password": "string",
        "username": "string",
        "port": 0,
    },
    workspace_id="string",
    definition_id="string",
    name="string")

const destinationSftpJsonResource = new airbyte.DestinationSftpJson("destinationSftpJsonResource", {
    configuration: {
        destinationPath: "string",
        host: "string",
        password: "string",
        username: "string",
        port: 0,
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
});

type: airbyte:DestinationSftpJson
properties:
    configuration:
        destinationPath: string
        host: string
        password: string
        port: 0
        username: string
    definitionId: string
    name: string
    workspaceId: string

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

Configuration DestinationSftpJsonConfiguration
WorkspaceId string
DefinitionId string: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
Name string: Name of the destination e.g. dev-mysql-instance.

Configuration DestinationSftpJsonConfigurationArgs
WorkspaceId string
DefinitionId string: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
Name string: Name of the destination e.g. dev-mysql-instance.

configuration DestinationSftpJsonConfiguration
workspaceId String
definitionId String: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
name String: Name of the destination e.g. dev-mysql-instance.

configuration DestinationSftpJsonConfiguration
workspaceId string
definitionId string: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
name string: Name of the destination e.g. dev-mysql-instance.

configuration DestinationSftpJsonConfigurationArgs
workspace_id str
definition_id str: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
name str: Name of the destination e.g. dev-mysql-instance.

configuration Property Map
workspaceId String
definitionId String: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
name String: Name of the destination e.g. dev-mysql-instance.

Outputs

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

CreatedAt double
DestinationId string
DestinationType string
Id string: The provider-assigned unique ID for this managed resource.
ResourceAllocation DestinationSftpJsonResourceAllocation: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.

CreatedAt float64
DestinationId string
DestinationType string
Id string: The provider-assigned unique ID for this managed resource.
ResourceAllocation DestinationSftpJsonResourceAllocation: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.

createdAt Double
destinationId String
destinationType String
id String: The provider-assigned unique ID for this managed resource.
resourceAllocation DestinationSftpJsonResourceAllocation: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.

createdAt number
destinationId string
destinationType string
id string: The provider-assigned unique ID for this managed resource.
resourceAllocation DestinationSftpJsonResourceAllocation: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.

created_at float
destination_id str
destination_type str
id str: The provider-assigned unique ID for this managed resource.
resource_allocation DestinationSftpJsonResourceAllocation: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.

createdAt Number
destinationId String
destinationType String
id String: The provider-assigned unique ID for this managed resource.
resourceAllocation Property Map: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.

Look up Existing DestinationSftpJson Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[DestinationSftpJsonConfigurationArgs] = None,
        created_at: Optional[float] = None,
        definition_id: Optional[str] = None,
        destination_id: Optional[str] = None,
        destination_type: Optional[str] = None,
        name: Optional[str] = None,
        resource_allocation: Optional[DestinationSftpJsonResourceAllocationArgs] = None,
        workspace_id: Optional[str] = None) -> DestinationSftpJson

func GetDestinationSftpJson(ctx *Context, name string, id IDInput, state *DestinationSftpJsonState, opts ...ResourceOption) (*DestinationSftpJson, error)

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

public static DestinationSftpJson get(String name, Output<String> id, DestinationSftpJsonState state, CustomResourceOptions options)

resources:  _:    type: airbyte:DestinationSftpJson    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 DestinationSftpJsonConfiguration
CreatedAt double
DefinitionId string: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
DestinationId string
DestinationType string
Name string: Name of the destination e.g. dev-mysql-instance.
ResourceAllocation DestinationSftpJsonResourceAllocation: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
WorkspaceId string

Configuration DestinationSftpJsonConfigurationArgs
CreatedAt float64
DefinitionId string: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
DestinationId string
DestinationType string
Name string: Name of the destination e.g. dev-mysql-instance.
ResourceAllocation DestinationSftpJsonResourceAllocationArgs: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
WorkspaceId string

configuration DestinationSftpJsonConfiguration
createdAt Double
definitionId String: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
destinationId String
destinationType String
name String: Name of the destination e.g. dev-mysql-instance.
resourceAllocation DestinationSftpJsonResourceAllocation: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
workspaceId String

configuration DestinationSftpJsonConfiguration
createdAt number
definitionId string: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
destinationId string
destinationType string
name string: Name of the destination e.g. dev-mysql-instance.
resourceAllocation DestinationSftpJsonResourceAllocation: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
workspaceId string

configuration DestinationSftpJsonConfigurationArgs
created_at float
definition_id str: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
destination_id str
destination_type str
name str: Name of the destination e.g. dev-mysql-instance.
resource_allocation DestinationSftpJsonResourceAllocationArgs: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
workspace_id str

configuration Property Map
createdAt Number
definitionId String: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
destinationId String
destinationType String
name String: Name of the destination e.g. dev-mysql-instance.
resourceAllocation Property Map: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
workspaceId String

Supporting Types

DestinationSftpJsonConfiguration, DestinationSftpJsonConfigurationArgs

DestinationPath string: Path to the directory where json files will be written.
Host string: Hostname of the SFTP server.
Password string: Password associated with the username.
Username string: Username to use to access the SFTP server.
Port double: Port of the SFTP server. Default: 22

DestinationPath string: Path to the directory where json files will be written.
Host string: Hostname of the SFTP server.
Password string: Password associated with the username.
Username string: Username to use to access the SFTP server.
Port float64: Port of the SFTP server. Default: 22

destinationPath String: Path to the directory where json files will be written.
host String: Hostname of the SFTP server.
password String: Password associated with the username.
username String: Username to use to access the SFTP server.
port Double: Port of the SFTP server. Default: 22

destinationPath string: Path to the directory where json files will be written.
host string: Hostname of the SFTP server.
password string: Password associated with the username.
username string: Username to use to access the SFTP server.
port number: Port of the SFTP server. Default: 22

destination_path str: Path to the directory where json files will be written.
host str: Hostname of the SFTP server.
password str: Password associated with the username.
username str: Username to use to access the SFTP server.
port float: Port of the SFTP server. Default: 22

destinationPath String: Path to the directory where json files will be written.
host String: Hostname of the SFTP server.
password String: Password associated with the username.
username String: Username to use to access the SFTP server.
port Number: Port of the SFTP server. Default: 22

DestinationSftpJsonResourceAllocation, DestinationSftpJsonResourceAllocationArgs

Default DestinationSftpJsonResourceAllocationDefault: optional resource requirements to run workers (blank for unbounded allocations)
JobSpecifics List<DestinationSftpJsonResourceAllocationJobSpecific>

Default DestinationSftpJsonResourceAllocationDefault: optional resource requirements to run workers (blank for unbounded allocations)
JobSpecifics []DestinationSftpJsonResourceAllocationJobSpecific

default_ DestinationSftpJsonResourceAllocationDefault: optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics List<DestinationSftpJsonResourceAllocationJobSpecific>

default DestinationSftpJsonResourceAllocationDefault: optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics DestinationSftpJsonResourceAllocationJobSpecific[]

default DestinationSftpJsonResourceAllocationDefault: optional resource requirements to run workers (blank for unbounded allocations)
job_specifics Sequence[DestinationSftpJsonResourceAllocationJobSpecific]

default Property Map: optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics List<Property Map>

DestinationSftpJsonResourceAllocationDefault, DestinationSftpJsonResourceAllocationDefaultArgs

CpuLimit string
CpuRequest string
EphemeralStorageLimit string
EphemeralStorageRequest string
MemoryLimit string
MemoryRequest string

CpuLimit string
CpuRequest string
EphemeralStorageLimit string
EphemeralStorageRequest string
MemoryLimit string
MemoryRequest string

cpuLimit String
cpuRequest String
ephemeralStorageLimit String
ephemeralStorageRequest String
memoryLimit String
memoryRequest String

cpuLimit string
cpuRequest string
ephemeralStorageLimit string
ephemeralStorageRequest string
memoryLimit string
memoryRequest string

cpu_limit str
cpu_request str
ephemeral_storage_limit str
ephemeral_storage_request str
memory_limit str
memory_request str

cpuLimit String
cpuRequest String
ephemeralStorageLimit String
ephemeralStorageRequest String
memoryLimit String
memoryRequest String

DestinationSftpJsonResourceAllocationJobSpecific, DestinationSftpJsonResourceAllocationJobSpecificArgs

JobType string: enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
ResourceRequirements DestinationSftpJsonResourceAllocationJobSpecificResourceRequirements: optional resource requirements to run workers (blank for unbounded allocations)

JobType string: enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
ResourceRequirements DestinationSftpJsonResourceAllocationJobSpecificResourceRequirements: optional resource requirements to run workers (blank for unbounded allocations)

jobType String: enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
resourceRequirements DestinationSftpJsonResourceAllocationJobSpecificResourceRequirements: optional resource requirements to run workers (blank for unbounded allocations)

jobType string: enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
resourceRequirements DestinationSftpJsonResourceAllocationJobSpecificResourceRequirements: optional resource requirements to run workers (blank for unbounded allocations)

job_type str: enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
resource_requirements DestinationSftpJsonResourceAllocationJobSpecificResourceRequirements: optional resource requirements to run workers (blank for unbounded allocations)

jobType String: enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
resourceRequirements Property Map: optional resource requirements to run workers (blank for unbounded allocations)

DestinationSftpJsonResourceAllocationJobSpecificResourceRequirements, DestinationSftpJsonResourceAllocationJobSpecificResourceRequirementsArgs

CpuLimit string
CpuRequest string
EphemeralStorageLimit string
EphemeralStorageRequest string
MemoryLimit string
MemoryRequest string

CpuLimit string
CpuRequest string
EphemeralStorageLimit string
EphemeralStorageRequest string
MemoryLimit string
MemoryRequest string

cpuLimit String
cpuRequest String
ephemeralStorageLimit String
ephemeralStorageRequest String
memoryLimit String
memoryRequest String

cpuLimit string
cpuRequest string
ephemeralStorageLimit string
ephemeralStorageRequest string
memoryLimit string
memoryRequest string

cpu_limit str
cpu_request str
ephemeral_storage_limit str
ephemeral_storage_request str
memory_limit str
memory_request str

cpuLimit String
cpuRequest String
ephemeralStorageLimit String
ephemeralStorageRequest String
memoryLimit String
memoryRequest String

Import

$ pulumi import airbyte:index/destinationSftpJson:DestinationSftpJson my_airbyte_destination_sftp_json ""

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.8.0-beta2 published on Thursday, Mar 27, 2025 by airbytehq

airbytehq/terraform-provider-airbyte

airbyte.DestinationSftpJson

On this page

On this page

Example Usage

Create DestinationSftpJson Resource

Constructor syntax

Parameters

Constructor example

DestinationSftpJson Resource Properties

Inputs

Outputs

Look up Existing DestinationSftpJson Resource

Supporting Types

DestinationSftpJsonConfiguration, DestinationSftpJsonConfigurationArgs

DestinationSftpJsonResourceAllocation, DestinationSftpJsonResourceAllocationArgs

DestinationSftpJsonResourceAllocationDefault, DestinationSftpJsonResourceAllocationDefaultArgs

DestinationSftpJsonResourceAllocationJobSpecific, DestinationSftpJsonResourceAllocationJobSpecificArgs

DestinationSftpJsonResourceAllocationJobSpecificResourceRequirements, DestinationSftpJsonResourceAllocationJobSpecificResourceRequirementsArgs

Import

Package Details

On this page

On this page