Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Airbyte Provider
  3. API Docs
  4. SourceAirtable
airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq
airbytehq/terraform-provider-airbyte

airbyte.SourceAirtable

Explore with Pulumi AI

airbyte logo
airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq
airbytehq/terraform-provider-airbyte

    SourceAirtable Resource

    Example Usage

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

const mySourceAirtable = new airbyte.SourceAirtable("mySourceAirtable", {
    configuration: {
        credentials: {
            oAuth20: {
                accessToken: "...my_access_token...",
                clientId: "...my_client_id...",
                clientSecret: "...my_client_secret...",
                refreshToken: "...my_refresh_token...",
                tokenExpiryDate: "2022-01-14T11:50:58.504Z",
            },
            personalAccessToken: {
                apiKey: "key1234567890",
            },
        },
    },
    definitionId: "fdd0b7d7-bc62-4e45-9809-2513b5f90d61",
    secretId: "...my_secret_id...",
    workspaceId: "110737e7-1846-4cca-8ebc-d0f82e4b8ffb",
});

    import pulumi
import pulumi_airbyte as airbyte

my_source_airtable = airbyte.SourceAirtable("mySourceAirtable",
    configuration={
        "credentials": {
            "o_auth20": {
                "access_token": "...my_access_token...",
                "client_id": "...my_client_id...",
                "client_secret": "...my_client_secret...",
                "refresh_token": "...my_refresh_token...",
                "token_expiry_date": "2022-01-14T11:50:58.504Z",
            },
            "personal_access_token": {
                "api_key": "key1234567890",
            },
        },
    },
    definition_id="fdd0b7d7-bc62-4e45-9809-2513b5f90d61",
    secret_id="...my_secret_id...",
    workspace_id="110737e7-1846-4cca-8ebc-d0f82e4b8ffb")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/airbyte/airbyte"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := airbyte.NewSourceAirtable(ctx, "mySourceAirtable", &airbyte.SourceAirtableArgs{
			Configuration: &airbyte.SourceAirtableConfigurationArgs{
				Credentials: &airbyte.SourceAirtableConfigurationCredentialsArgs{
					OAuth20: &airbyte.SourceAirtableConfigurationCredentialsOAuth20Args{
						AccessToken:     pulumi.String("...my_access_token..."),
						ClientId:        pulumi.String("...my_client_id..."),
						ClientSecret:    pulumi.String("...my_client_secret..."),
						RefreshToken:    pulumi.String("...my_refresh_token..."),
						TokenExpiryDate: pulumi.String("2022-01-14T11:50:58.504Z"),
					},
					PersonalAccessToken: &airbyte.SourceAirtableConfigurationCredentialsPersonalAccessTokenArgs{
						ApiKey: pulumi.String("key1234567890"),
					},
				},
			},
			DefinitionId: pulumi.String("fdd0b7d7-bc62-4e45-9809-2513b5f90d61"),
			SecretId:     pulumi.String("...my_secret_id..."),
			WorkspaceId:  pulumi.String("110737e7-1846-4cca-8ebc-d0f82e4b8ffb"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var mySourceAirtable = new Airbyte.SourceAirtable("mySourceAirtable", new()
    {
        Configuration = new Airbyte.Inputs.SourceAirtableConfigurationArgs
        {
            Credentials = new Airbyte.Inputs.SourceAirtableConfigurationCredentialsArgs
            {
                OAuth20 = new Airbyte.Inputs.SourceAirtableConfigurationCredentialsOAuth20Args
                {
                    AccessToken = "...my_access_token...",
                    ClientId = "...my_client_id...",
                    ClientSecret = "...my_client_secret...",
                    RefreshToken = "...my_refresh_token...",
                    TokenExpiryDate = "2022-01-14T11:50:58.504Z",
                },
                PersonalAccessToken = new Airbyte.Inputs.SourceAirtableConfigurationCredentialsPersonalAccessTokenArgs
                {
                    ApiKey = "key1234567890",
                },
            },
        },
        DefinitionId = "fdd0b7d7-bc62-4e45-9809-2513b5f90d61",
        SecretId = "...my_secret_id...",
        WorkspaceId = "110737e7-1846-4cca-8ebc-d0f82e4b8ffb",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.airbyte.SourceAirtable;
import com.pulumi.airbyte.SourceAirtableArgs;
import com.pulumi.airbyte.inputs.SourceAirtableConfigurationArgs;
import com.pulumi.airbyte.inputs.SourceAirtableConfigurationCredentialsArgs;
import com.pulumi.airbyte.inputs.SourceAirtableConfigurationCredentialsOAuth20Args;
import com.pulumi.airbyte.inputs.SourceAirtableConfigurationCredentialsPersonalAccessTokenArgs;
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 mySourceAirtable = new SourceAirtable("mySourceAirtable", SourceAirtableArgs.builder()
            .configuration(SourceAirtableConfigurationArgs.builder()
                .credentials(SourceAirtableConfigurationCredentialsArgs.builder()
                    .oAuth20(SourceAirtableConfigurationCredentialsOAuth20Args.builder()
                        .accessToken("...my_access_token...")
                        .clientId("...my_client_id...")
                        .clientSecret("...my_client_secret...")
                        .refreshToken("...my_refresh_token...")
                        .tokenExpiryDate("2022-01-14T11:50:58.504Z")
                        .build())
                    .personalAccessToken(SourceAirtableConfigurationCredentialsPersonalAccessTokenArgs.builder()
                        .apiKey("key1234567890")
                        .build())
                    .build())
                .build())
            .definitionId("fdd0b7d7-bc62-4e45-9809-2513b5f90d61")
            .secretId("...my_secret_id...")
            .workspaceId("110737e7-1846-4cca-8ebc-d0f82e4b8ffb")
            .build());

    }
}

    resources:
  mySourceAirtable:
    type: airbyte:SourceAirtable
    properties:
      configuration:
        credentials:
          oAuth20:
            accessToken: '...my_access_token...'
            clientId: '...my_client_id...'
            clientSecret: '...my_client_secret...'
            refreshToken: '...my_refresh_token...'
            tokenExpiryDate: 2022-01-14T11:50:58.504Z
          personalAccessToken:
            apiKey: key1234567890
      definitionId: fdd0b7d7-bc62-4e45-9809-2513b5f90d61
      secretId: '...my_secret_id...'
      workspaceId: 110737e7-1846-4cca-8ebc-d0f82e4b8ffb

    Create SourceAirtable Resource

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

    Constructor syntax

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

@overload
def SourceAirtable(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   configuration: Optional[SourceAirtableConfigurationArgs] = None,
                   workspace_id: Optional[str] = None,
                   definition_id: Optional[str] = None,
                   name: Optional[str] = None,
                   secret_id: Optional[str] = None)
    func NewSourceAirtable(ctx *Context, name string, args SourceAirtableArgs, opts ...ResourceOption) (*SourceAirtable, error)
    public SourceAirtable(string name, SourceAirtableArgs args, CustomResourceOptions? opts = null)
    public SourceAirtable(String name, SourceAirtableArgs args)
public SourceAirtable(String name, SourceAirtableArgs args, CustomResourceOptions options)

    type: airbyte:SourceAirtable
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 SourceAirtableArgs
    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 SourceAirtableArgs
    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 SourceAirtableArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SourceAirtableArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SourceAirtableArgs
    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 sourceAirtableResource = new Airbyte.SourceAirtable("sourceAirtableResource", new()
{
    Configuration = new Airbyte.Inputs.SourceAirtableConfigurationArgs
    {
        Credentials = new Airbyte.Inputs.SourceAirtableConfigurationCredentialsArgs
        {
            OAuth20 = new Airbyte.Inputs.SourceAirtableConfigurationCredentialsOAuth20Args
            {
                ClientId = "string",
                ClientSecret = "string",
                RefreshToken = "string",
                AccessToken = "string",
                TokenExpiryDate = "string",
            },
            PersonalAccessToken = new Airbyte.Inputs.SourceAirtableConfigurationCredentialsPersonalAccessTokenArgs
            {
                ApiKey = "string",
            },
        },
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});

    example, err := airbyte.NewSourceAirtable(ctx, "sourceAirtableResource", &airbyte.SourceAirtableArgs{
Configuration: &.SourceAirtableConfigurationArgs{
Credentials: &.SourceAirtableConfigurationCredentialsArgs{
OAuth20: &.SourceAirtableConfigurationCredentialsOAuth20Args{
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
RefreshToken: pulumi.String("string"),
AccessToken: pulumi.String("string"),
TokenExpiryDate: pulumi.String("string"),
},
PersonalAccessToken: &.SourceAirtableConfigurationCredentialsPersonalAccessTokenArgs{
ApiKey: pulumi.String("string"),
},
},
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})

    var sourceAirtableResource = new SourceAirtable("sourceAirtableResource", SourceAirtableArgs.builder()
    .configuration(SourceAirtableConfigurationArgs.builder()
        .credentials(SourceAirtableConfigurationCredentialsArgs.builder()
            .oAuth20(SourceAirtableConfigurationCredentialsOAuth20Args.builder()
                .clientId("string")
                .clientSecret("string")
                .refreshToken("string")
                .accessToken("string")
                .tokenExpiryDate("string")
                .build())
            .personalAccessToken(SourceAirtableConfigurationCredentialsPersonalAccessTokenArgs.builder()
                .apiKey("string")
                .build())
            .build())
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());

    source_airtable_resource = airbyte.SourceAirtable("sourceAirtableResource",
    configuration={
        "credentials": {
            "o_auth20": {
                "client_id": "string",
                "client_secret": "string",
                "refresh_token": "string",
                "access_token": "string",
                "token_expiry_date": "string",
            },
            "personal_access_token": {
                "api_key": "string",
            },
        },
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")

    const sourceAirtableResource = new airbyte.SourceAirtable("sourceAirtableResource", {
    configuration: {
        credentials: {
            oAuth20: {
                clientId: "string",
                clientSecret: "string",
                refreshToken: "string",
                accessToken: "string",
                tokenExpiryDate: "string",
            },
            personalAccessToken: {
                apiKey: "string",
            },
        },
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});

    type: airbyte:SourceAirtable
properties:
    configuration:
        credentials:
            oAuth20:
                accessToken: string
                clientId: string
                clientSecret: string
                refreshToken: string
                tokenExpiryDate: string
            personalAccessToken:
                apiKey: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string

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

    Configuration SourceAirtableConfiguration
    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 SourceAirtableConfigurationArgs
    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 SourceAirtableConfiguration
    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 SourceAirtableConfiguration
    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 SourceAirtableConfigurationArgs
    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 SourceAirtable 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 SourceAirtable Resource

    Get an existing SourceAirtable 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?: SourceAirtableState, opts?: CustomResourceOptions): SourceAirtable
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourceAirtableConfigurationArgs] = 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) -> SourceAirtable
    func GetSourceAirtable(ctx *Context, name string, id IDInput, state *SourceAirtableState, opts ...ResourceOption) (*SourceAirtable, error)
    public static SourceAirtable Get(string name, Input<string> id, SourceAirtableState? state, CustomResourceOptions? opts = null)
    public static SourceAirtable get(String name, Output<String> id, SourceAirtableState state, CustomResourceOptions options)
    resources:  _:    type: airbyte:SourceAirtable    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 SourceAirtableConfiguration
    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 SourceAirtableConfigurationArgs
    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 SourceAirtableConfiguration
    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 SourceAirtableConfiguration
    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 SourceAirtableConfigurationArgs
    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

    SourceAirtableConfiguration, SourceAirtableConfigurationArgs

    SourceAirtableConfigurationCredentials, SourceAirtableConfigurationCredentialsArgs

    SourceAirtableConfigurationCredentialsOAuth20, SourceAirtableConfigurationCredentialsOAuth20Args

    ClientId string
    The client ID of the Airtable developer application.
    ClientSecret string
    The client secret of the Airtable developer application.
    RefreshToken string
    The key to refresh the expired access token.
    AccessToken string
    Access Token for making authenticated requests.
    TokenExpiryDate string
    The date-time when the access token should be refreshed.
    ClientId string
    The client ID of the Airtable developer application.
    ClientSecret string
    The client secret of the Airtable developer application.
    RefreshToken string
    The key to refresh the expired access token.
    AccessToken string
    Access Token for making authenticated requests.
    TokenExpiryDate string
    The date-time when the access token should be refreshed.
    clientId String
    The client ID of the Airtable developer application.
    clientSecret String
    The client secret of the Airtable developer application.
    refreshToken String
    The key to refresh the expired access token.
    accessToken String
    Access Token for making authenticated requests.
    tokenExpiryDate String
    The date-time when the access token should be refreshed.
    clientId string
    The client ID of the Airtable developer application.
    clientSecret string
    The client secret of the Airtable developer application.
    refreshToken string
    The key to refresh the expired access token.
    accessToken string
    Access Token for making authenticated requests.
    tokenExpiryDate string
    The date-time when the access token should be refreshed.
    client_id str
    The client ID of the Airtable developer application.
    client_secret str
    The client secret of the Airtable developer application.
    refresh_token str
    The key to refresh the expired access token.
    access_token str
    Access Token for making authenticated requests.
    token_expiry_date str
    The date-time when the access token should be refreshed.
    clientId String
    The client ID of the Airtable developer application.
    clientSecret String
    The client secret of the Airtable developer application.
    refreshToken String
    The key to refresh the expired access token.
    accessToken String
    Access Token for making authenticated requests.
    tokenExpiryDate String
    The date-time when the access token should be refreshed.

    SourceAirtableConfigurationCredentialsPersonalAccessToken, SourceAirtableConfigurationCredentialsPersonalAccessTokenArgs

    ApiKey string
    The Personal Access Token for the Airtable account. See the \n\nSupport Guide\n\n for more information on how to obtain this token.
    ApiKey string
    The Personal Access Token for the Airtable account. See the \n\nSupport Guide\n\n for more information on how to obtain this token.
    apiKey String
    The Personal Access Token for the Airtable account. See the \n\nSupport Guide\n\n for more information on how to obtain this token.
    apiKey string
    The Personal Access Token for the Airtable account. See the \n\nSupport Guide\n\n for more information on how to obtain this token.
    api_key str
    The Personal Access Token for the Airtable account. See the \n\nSupport Guide\n\n for more information on how to obtain this token.
    apiKey String
    The Personal Access Token for the Airtable account. See the \n\nSupport Guide\n\n for more information on how to obtain this token.

    Import

    $ pulumi import airbyte:index/sourceAirtable:SourceAirtable my_airbyte_source_airtable ""

    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 logo
    airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq
    airbytehq/terraform-provider-airbyte