airbyte 0.7.0-beta2, Mar 7 25

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

airbyte.SourcePlaid

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.SourcePlaid;
import com.pulumi.airbyte.SourcePlaidArgs;
import com.pulumi.airbyte.inputs.SourcePlaidConfigurationArgs;
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 mySourcePlaid = new SourcePlaid("mySourcePlaid", SourcePlaidArgs.builder()
            .configuration(SourcePlaidConfigurationArgs.builder()
                .access_token("...my_access_token...")
                .api_key("...my_api_key...")
                .client_id("...my_client_id...")
                .plaid_env("sandbox")
                .start_date("2022-03-19")
                .build())
            .definitionId("44b2eab0-7f1c-42f4-907b-f94107b2f6c4")
            .secretId("...my_secret_id...")
            .workspaceId("59a946a0-15f9-4907-92fa-47403fc1e3d9")
            .build());

    }
}

resources:
  mySourcePlaid:
    type: airbyte:SourcePlaid
    properties:
      configuration:
        access_token: '...my_access_token...'
        api_key: '...my_api_key...'
        client_id: '...my_client_id...'
        plaid_env: sandbox
        start_date: 2022-03-19
      definitionId: 44b2eab0-7f1c-42f4-907b-f94107b2f6c4
      secretId: '...my_secret_id...'
      workspaceId: 59a946a0-15f9-4907-92fa-47403fc1e3d9

Create SourcePlaid Resource

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

Constructor syntax

new SourcePlaid(name: string, args: SourcePlaidArgs, opts?: CustomResourceOptions);

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

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

func NewSourcePlaid(ctx *Context, name string, args SourcePlaidArgs, opts ...ResourceOption) (*SourcePlaid, error)

public SourcePlaid(string name, SourcePlaidArgs args, CustomResourceOptions? opts = null)

public SourcePlaid(String name, SourcePlaidArgs args)
public SourcePlaid(String name, SourcePlaidArgs args, CustomResourceOptions options)

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

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

name String: The unique name of the resource.
args SourcePlaidArgs: 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 sourcePlaidResource = new Airbyte.SourcePlaid("sourcePlaidResource", new()
{
    Configuration = new Airbyte.Inputs.SourcePlaidConfigurationArgs
    {
        AccessToken = "string",
        ApiKey = "string",
        ClientId = "string",
        PlaidEnv = "string",
        StartDate = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});

example, err := airbyte.NewSourcePlaid(ctx, "sourcePlaidResource", &airbyte.SourcePlaidArgs{
Configuration: &.SourcePlaidConfigurationArgs{
AccessToken: pulumi.String("string"),
ApiKey: pulumi.String("string"),
ClientId: pulumi.String("string"),
PlaidEnv: pulumi.String("string"),
StartDate: pulumi.String("string"),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})

var sourcePlaidResource = new SourcePlaid("sourcePlaidResource", SourcePlaidArgs.builder()
    .configuration(SourcePlaidConfigurationArgs.builder()
        .accessToken("string")
        .apiKey("string")
        .clientId("string")
        .plaidEnv("string")
        .startDate("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());

source_plaid_resource = airbyte.SourcePlaid("sourcePlaidResource",
    configuration={
        "access_token": "string",
        "api_key": "string",
        "client_id": "string",
        "plaid_env": "string",
        "start_date": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")

const sourcePlaidResource = new airbyte.SourcePlaid("sourcePlaidResource", {
    configuration: {
        accessToken: "string",
        apiKey: "string",
        clientId: "string",
        plaidEnv: "string",
        startDate: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});

type: airbyte:SourcePlaid
properties:
    configuration:
        accessToken: string
        apiKey: string
        clientId: string
        plaidEnv: string
        startDate: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string

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

Configuration SourcePlaidConfiguration
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 SourcePlaidConfigurationArgs
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 SourcePlaidConfiguration
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 SourcePlaidConfiguration
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 SourcePlaidConfigurationArgs
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 SourcePlaid 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 SourcePlaid Resource

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

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

func GetSourcePlaid(ctx *Context, name string, id IDInput, state *SourcePlaidState, opts ...ResourceOption) (*SourcePlaid, error)

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

public static SourcePlaid get(String name, Output<String> id, SourcePlaidState state, CustomResourceOptions options)

resources:  _:    type: airbyte:SourcePlaid    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 SourcePlaidConfiguration
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 SourcePlaidConfigurationArgs
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 SourcePlaidConfiguration
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 SourcePlaidConfiguration
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 SourcePlaidConfigurationArgs
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

SourcePlaidConfiguration, SourcePlaidConfigurationArgs

AccessToken string: The end-user's Link access token.
ApiKey string: The Plaid API key to use to hit the API.
ClientId string: The Plaid client id.
PlaidEnv string: The Plaid environment. must be one of ["sandbox", "development", "production"]
StartDate string: The date from which you'd like to replicate data for Plaid in the format YYYY-MM-DD. All data generated after this date will be replicated.

AccessToken string: The end-user's Link access token.
ApiKey string: The Plaid API key to use to hit the API.
ClientId string: The Plaid client id.
PlaidEnv string: The Plaid environment. must be one of ["sandbox", "development", "production"]
StartDate string: The date from which you'd like to replicate data for Plaid in the format YYYY-MM-DD. All data generated after this date will be replicated.

accessToken String: The end-user's Link access token.
apiKey String: The Plaid API key to use to hit the API.
clientId String: The Plaid client id.
plaidEnv String: The Plaid environment. must be one of ["sandbox", "development", "production"]
startDate String: The date from which you'd like to replicate data for Plaid in the format YYYY-MM-DD. All data generated after this date will be replicated.

accessToken string: The end-user's Link access token.
apiKey string: The Plaid API key to use to hit the API.
clientId string: The Plaid client id.
plaidEnv string: The Plaid environment. must be one of ["sandbox", "development", "production"]
startDate string: The date from which you'd like to replicate data for Plaid in the format YYYY-MM-DD. All data generated after this date will be replicated.

access_token str: The end-user's Link access token.
api_key str: The Plaid API key to use to hit the API.
client_id str: The Plaid client id.
plaid_env str: The Plaid environment. must be one of ["sandbox", "development", "production"]
start_date str: The date from which you'd like to replicate data for Plaid in the format YYYY-MM-DD. All data generated after this date will be replicated.

accessToken String: The end-user's Link access token.
apiKey String: The Plaid API key to use to hit the API.
clientId String: The Plaid client id.
plaidEnv String: The Plaid environment. must be one of ["sandbox", "development", "production"]
startDate String: The date from which you'd like to replicate data for Plaid in the format YYYY-MM-DD. All data generated after this date will be replicated.

Import

$ pulumi import airbyte:index/sourcePlaid:SourcePlaid my_airbyte_source_plaid ""

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

On this page

On this page

Example Usage

Create SourcePlaid Resource

Constructor syntax

Parameters

Constructor example

SourcePlaid Resource Properties

Inputs

Outputs

Look up Existing SourcePlaid Resource

Supporting Types

SourcePlaidConfiguration, SourcePlaidConfigurationArgs

Import

Package Details

On this page

On this page