airbyte 0.7.0-beta2, Mar 7 25

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

airbyte.SourceSalesforce

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.SourceSalesforce;
import com.pulumi.airbyte.SourceSalesforceArgs;
import com.pulumi.airbyte.inputs.SourceSalesforceConfigurationArgs;
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 mySourceSalesforce = new SourceSalesforce("mySourceSalesforce", SourceSalesforceArgs.builder()
            .configuration(SourceSalesforceConfigurationArgs.builder()
                .client_id("...my_client_id...")
                .client_secret("...my_client_secret...")
                .force_use_bulk_api(true)
                .is_sandbox(false)
                .refresh_token("...my_refresh_token...")
                .start_date("2021-07-25")
                .stream_slice_step("PT12H")
                .streams_criteria(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                .build())
            .definitionId("ac775334-3ab2-43d2-b41a-9b554542b831")
            .secretId("...my_secret_id...")
            .workspaceId("009ca65a-dea0-4cfe-b1a6-e5f50c2ef465")
            .build());

    }
}

resources:
  mySourceSalesforce:
    type: airbyte:SourceSalesforce
    properties:
      configuration:
        client_id: '...my_client_id...'
        client_secret: '...my_client_secret...'
        force_use_bulk_api: true
        is_sandbox: false
        refresh_token: '...my_refresh_token...'
        start_date: 2021-07-25
        stream_slice_step: PT12H
        streams_criteria:
          - criteria: not contains
            value: '...my_value...'
      definitionId: ac775334-3ab2-43d2-b41a-9b554542b831
      secretId: '...my_secret_id...'
      workspaceId: 009ca65a-dea0-4cfe-b1a6-e5f50c2ef465

Create SourceSalesforce Resource

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

Constructor syntax

new SourceSalesforce(name: string, args: SourceSalesforceArgs, opts?: CustomResourceOptions);

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

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

func NewSourceSalesforce(ctx *Context, name string, args SourceSalesforceArgs, opts ...ResourceOption) (*SourceSalesforce, error)

public SourceSalesforce(string name, SourceSalesforceArgs args, CustomResourceOptions? opts = null)

public SourceSalesforce(String name, SourceSalesforceArgs args)
public SourceSalesforce(String name, SourceSalesforceArgs args, CustomResourceOptions options)

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

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

name String: The unique name of the resource.
args SourceSalesforceArgs: 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 sourceSalesforceResource = new Airbyte.SourceSalesforce("sourceSalesforceResource", new()
{
    Configuration = new Airbyte.Inputs.SourceSalesforceConfigurationArgs
    {
        ClientId = "string",
        ClientSecret = "string",
        RefreshToken = "string",
        ForceUseBulkApi = false,
        IsSandbox = false,
        StartDate = "string",
        StreamSliceStep = "string",
        StreamsCriterias = new[]
        {
            new Airbyte.Inputs.SourceSalesforceConfigurationStreamsCriteriaArgs
            {
                Value = "string",
                Criteria = "string",
            },
        },
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});

example, err := airbyte.NewSourceSalesforce(ctx, "sourceSalesforceResource", &airbyte.SourceSalesforceArgs{
Configuration: &.SourceSalesforceConfigurationArgs{
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
RefreshToken: pulumi.String("string"),
ForceUseBulkApi: pulumi.Bool(false),
IsSandbox: pulumi.Bool(false),
StartDate: pulumi.String("string"),
StreamSliceStep: pulumi.String("string"),
StreamsCriterias: .SourceSalesforceConfigurationStreamsCriteriaArray{
&.SourceSalesforceConfigurationStreamsCriteriaArgs{
Value: pulumi.String("string"),
Criteria: pulumi.String("string"),
},
},
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})

var sourceSalesforceResource = new SourceSalesforce("sourceSalesforceResource", SourceSalesforceArgs.builder()
    .configuration(SourceSalesforceConfigurationArgs.builder()
        .clientId("string")
        .clientSecret("string")
        .refreshToken("string")
        .forceUseBulkApi(false)
        .isSandbox(false)
        .startDate("string")
        .streamSliceStep("string")
        .streamsCriterias(SourceSalesforceConfigurationStreamsCriteriaArgs.builder()
            .value("string")
            .criteria("string")
            .build())
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());

source_salesforce_resource = airbyte.SourceSalesforce("sourceSalesforceResource",
    configuration={
        "client_id": "string",
        "client_secret": "string",
        "refresh_token": "string",
        "force_use_bulk_api": False,
        "is_sandbox": False,
        "start_date": "string",
        "stream_slice_step": "string",
        "streams_criterias": [{
            "value": "string",
            "criteria": "string",
        }],
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")

const sourceSalesforceResource = new airbyte.SourceSalesforce("sourceSalesforceResource", {
    configuration: {
        clientId: "string",
        clientSecret: "string",
        refreshToken: "string",
        forceUseBulkApi: false,
        isSandbox: false,
        startDate: "string",
        streamSliceStep: "string",
        streamsCriterias: [{
            value: "string",
            criteria: "string",
        }],
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});

type: airbyte:SourceSalesforce
properties:
    configuration:
        clientId: string
        clientSecret: string
        forceUseBulkApi: false
        isSandbox: false
        refreshToken: string
        startDate: string
        streamSliceStep: string
        streamsCriterias:
            - criteria: string
              value: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string

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

Configuration SourceSalesforceConfiguration
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 SourceSalesforceConfigurationArgs
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 SourceSalesforceConfiguration
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 SourceSalesforceConfiguration
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 SourceSalesforceConfigurationArgs
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 SourceSalesforce 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 SourceSalesforce Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourceSalesforceConfigurationArgs] = 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) -> SourceSalesforce

func GetSourceSalesforce(ctx *Context, name string, id IDInput, state *SourceSalesforceState, opts ...ResourceOption) (*SourceSalesforce, error)

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

public static SourceSalesforce get(String name, Output<String> id, SourceSalesforceState state, CustomResourceOptions options)

resources:  _:    type: airbyte:SourceSalesforce    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 SourceSalesforceConfiguration
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 SourceSalesforceConfigurationArgs
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 SourceSalesforceConfiguration
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 SourceSalesforceConfiguration
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 SourceSalesforceConfigurationArgs
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

SourceSalesforceConfiguration, SourceSalesforceConfigurationArgs

ClientId string: Enter your Salesforce developer application's \n\nClient ID\n\n
ClientSecret string: Enter your Salesforce developer application's \n\nClient secret\n\n
RefreshToken string: Enter your application's \n\nSalesforce Refresh Token\n\n used for Airbyte to access your Salesforce account.
ForceUseBulkApi bool: Toggle to use Bulk API (this might cause empty fields for some streams). Default: false
IsSandbox bool: Toggle if you're using a \n\nSalesforce Sandbox\n\n. Default: false
StartDate string: Enter the date (or date-time) in the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ssZ format. Airbyte will replicate the data updated on and after this date. If this field is blank, Airbyte will replicate the data for last two years.
StreamSliceStep string: The size of the time window (ISO8601 duration) to slice requests. Default: "P30D"
StreamsCriterias List<SourceSalesforceConfigurationStreamsCriteria>: Add filters to select only required stream based on SObject name. Use this field to filter which tables are displayed by this connector. This is useful if your Salesforce account has a large number of tables (>1000), in which case you may find it easier to navigate the UI and speed up the connector's performance if you restrict the tables displayed by this connector.

ClientId string: Enter your Salesforce developer application's \n\nClient ID\n\n
ClientSecret string: Enter your Salesforce developer application's \n\nClient secret\n\n
RefreshToken string: Enter your application's \n\nSalesforce Refresh Token\n\n used for Airbyte to access your Salesforce account.
ForceUseBulkApi bool: Toggle to use Bulk API (this might cause empty fields for some streams). Default: false
IsSandbox bool: Toggle if you're using a \n\nSalesforce Sandbox\n\n. Default: false
StartDate string: Enter the date (or date-time) in the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ssZ format. Airbyte will replicate the data updated on and after this date. If this field is blank, Airbyte will replicate the data for last two years.
StreamSliceStep string: The size of the time window (ISO8601 duration) to slice requests. Default: "P30D"
StreamsCriterias []SourceSalesforceConfigurationStreamsCriteria: Add filters to select only required stream based on SObject name. Use this field to filter which tables are displayed by this connector. This is useful if your Salesforce account has a large number of tables (>1000), in which case you may find it easier to navigate the UI and speed up the connector's performance if you restrict the tables displayed by this connector.

clientId String: Enter your Salesforce developer application's \n\nClient ID\n\n
clientSecret String: Enter your Salesforce developer application's \n\nClient secret\n\n
refreshToken String: Enter your application's \n\nSalesforce Refresh Token\n\n used for Airbyte to access your Salesforce account.
forceUseBulkApi Boolean: Toggle to use Bulk API (this might cause empty fields for some streams). Default: false
isSandbox Boolean: Toggle if you're using a \n\nSalesforce Sandbox\n\n. Default: false
startDate String: Enter the date (or date-time) in the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ssZ format. Airbyte will replicate the data updated on and after this date. If this field is blank, Airbyte will replicate the data for last two years.
streamSliceStep String: The size of the time window (ISO8601 duration) to slice requests. Default: "P30D"
streamsCriterias List<SourceSalesforceConfigurationStreamsCriteria>: Add filters to select only required stream based on SObject name. Use this field to filter which tables are displayed by this connector. This is useful if your Salesforce account has a large number of tables (>1000), in which case you may find it easier to navigate the UI and speed up the connector's performance if you restrict the tables displayed by this connector.

clientId string: Enter your Salesforce developer application's \n\nClient ID\n\n
clientSecret string: Enter your Salesforce developer application's \n\nClient secret\n\n
refreshToken string: Enter your application's \n\nSalesforce Refresh Token\n\n used for Airbyte to access your Salesforce account.
forceUseBulkApi boolean: Toggle to use Bulk API (this might cause empty fields for some streams). Default: false
isSandbox boolean: Toggle if you're using a \n\nSalesforce Sandbox\n\n. Default: false
startDate string: Enter the date (or date-time) in the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ssZ format. Airbyte will replicate the data updated on and after this date. If this field is blank, Airbyte will replicate the data for last two years.
streamSliceStep string: The size of the time window (ISO8601 duration) to slice requests. Default: "P30D"
streamsCriterias SourceSalesforceConfigurationStreamsCriteria[]: Add filters to select only required stream based on SObject name. Use this field to filter which tables are displayed by this connector. This is useful if your Salesforce account has a large number of tables (>1000), in which case you may find it easier to navigate the UI and speed up the connector's performance if you restrict the tables displayed by this connector.

client_id str: Enter your Salesforce developer application's \n\nClient ID\n\n
client_secret str: Enter your Salesforce developer application's \n\nClient secret\n\n
refresh_token str: Enter your application's \n\nSalesforce Refresh Token\n\n used for Airbyte to access your Salesforce account.
force_use_bulk_api bool: Toggle to use Bulk API (this might cause empty fields for some streams). Default: false
is_sandbox bool: Toggle if you're using a \n\nSalesforce Sandbox\n\n. Default: false
start_date str: Enter the date (or date-time) in the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ssZ format. Airbyte will replicate the data updated on and after this date. If this field is blank, Airbyte will replicate the data for last two years.
stream_slice_step str: The size of the time window (ISO8601 duration) to slice requests. Default: "P30D"
streams_criterias Sequence[SourceSalesforceConfigurationStreamsCriteria]: Add filters to select only required stream based on SObject name. Use this field to filter which tables are displayed by this connector. This is useful if your Salesforce account has a large number of tables (>1000), in which case you may find it easier to navigate the UI and speed up the connector's performance if you restrict the tables displayed by this connector.

clientId String: Enter your Salesforce developer application's \n\nClient ID\n\n
clientSecret String: Enter your Salesforce developer application's \n\nClient secret\n\n
refreshToken String: Enter your application's \n\nSalesforce Refresh Token\n\n used for Airbyte to access your Salesforce account.
forceUseBulkApi Boolean: Toggle to use Bulk API (this might cause empty fields for some streams). Default: false
isSandbox Boolean: Toggle if you're using a \n\nSalesforce Sandbox\n\n. Default: false
startDate String: Enter the date (or date-time) in the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ssZ format. Airbyte will replicate the data updated on and after this date. If this field is blank, Airbyte will replicate the data for last two years.
streamSliceStep String: The size of the time window (ISO8601 duration) to slice requests. Default: "P30D"
streamsCriterias List<Property Map>: Add filters to select only required stream based on SObject name. Use this field to filter which tables are displayed by this connector. This is useful if your Salesforce account has a large number of tables (>1000), in which case you may find it easier to navigate the UI and speed up the connector's performance if you restrict the tables displayed by this connector.

SourceSalesforceConfigurationStreamsCriteria, SourceSalesforceConfigurationStreamsCriteriaArgs

Value string
Criteria string: Default: "contains"; must be one of ["starts with", "ends with", "contains", "exacts", "starts not with", "ends not with", "not contains", "not exacts"]

Value string
Criteria string: Default: "contains"; must be one of ["starts with", "ends with", "contains", "exacts", "starts not with", "ends not with", "not contains", "not exacts"]

value String
criteria String: Default: "contains"; must be one of ["starts with", "ends with", "contains", "exacts", "starts not with", "ends not with", "not contains", "not exacts"]

value string
criteria string: Default: "contains"; must be one of ["starts with", "ends with", "contains", "exacts", "starts not with", "ends not with", "not contains", "not exacts"]

value str
criteria str: Default: "contains"; must be one of ["starts with", "ends with", "contains", "exacts", "starts not with", "ends not with", "not contains", "not exacts"]

value String
criteria String: Default: "contains"; must be one of ["starts with", "ends with", "contains", "exacts", "starts not with", "ends not with", "not contains", "not exacts"]

Import

$ pulumi import airbyte:index/sourceSalesforce:SourceSalesforce my_airbyte_source_salesforce ""

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.SourceSalesforce

On this page

On this page

Example Usage

Create SourceSalesforce Resource

Constructor syntax

Parameters

Constructor example

SourceSalesforce Resource Properties

Inputs

Outputs

Look up Existing SourceSalesforce Resource

Supporting Types

SourceSalesforceConfiguration, SourceSalesforceConfigurationArgs

SourceSalesforceConfigurationStreamsCriteria, SourceSalesforceConfigurationStreamsCriteriaArgs

Import

Package Details

On this page

On this page