1. Packages
  2. Airbyte Provider
  3. API Docs
  4. SourceInstagram
airbyte 0.10.0 published on Monday, Apr 14, 2025 by airbytehq

airbyte.SourceInstagram

Explore with Pulumi AI

SourceInstagram Resource

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.SourceInstagram;
import com.pulumi.airbyte.SourceInstagramArgs;
import com.pulumi.airbyte.inputs.SourceInstagramConfigurationArgs;
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 mySourceInstagram = new SourceInstagram("mySourceInstagram", SourceInstagramArgs.builder()
            .configuration(SourceInstagramConfigurationArgs.builder()
                .access_token("...my_access_token...")
                .client_id("...my_client_id...")
                .client_secret("...my_client_secret...")
                .num_workers(1)
                .start_date("2017-01-25T00:00:00Z")
                .build())
            .definitionId("f2ba9b6a-282f-49c9-ad1c-418c8b8d173c")
            .secretId("...my_secret_id...")
            .workspaceId("c12b19f2-4972-490b-ae38-c64d9c068d4d")
            .build());

    }
}
Copy
resources:
  mySourceInstagram:
    type: airbyte:SourceInstagram
    properties:
      configuration:
        access_token: '...my_access_token...'
        client_id: '...my_client_id...'
        client_secret: '...my_client_secret...'
        num_workers: 1
        start_date: 2017-01-25T00:00:00Z
      definitionId: f2ba9b6a-282f-49c9-ad1c-418c8b8d173c
      secretId: '...my_secret_id...'
      workspaceId: c12b19f2-4972-490b-ae38-c64d9c068d4d
Copy

Create SourceInstagram Resource

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

Constructor syntax

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

@overload
def SourceInstagram(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    configuration: Optional[SourceInstagramConfigurationArgs] = None,
                    workspace_id: Optional[str] = None,
                    definition_id: Optional[str] = None,
                    name: Optional[str] = None,
                    secret_id: Optional[str] = None)
func NewSourceInstagram(ctx *Context, name string, args SourceInstagramArgs, opts ...ResourceOption) (*SourceInstagram, error)
public SourceInstagram(string name, SourceInstagramArgs args, CustomResourceOptions? opts = null)
public SourceInstagram(String name, SourceInstagramArgs args)
public SourceInstagram(String name, SourceInstagramArgs args, CustomResourceOptions options)
type: airbyte:SourceInstagram
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SourceInstagramArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. SourceInstagramArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. SourceInstagramArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SourceInstagramArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SourceInstagramArgs
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 sourceInstagramResource = new Airbyte.SourceInstagram("sourceInstagramResource", new()
{
    Configuration = new Airbyte.Inputs.SourceInstagramConfigurationArgs
    {
        AccessToken = "string",
        ClientId = "string",
        ClientSecret = "string",
        NumWorkers = 0,
        StartDate = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});
Copy
example, err := airbyte.NewSourceInstagram(ctx, "sourceInstagramResource", &airbyte.SourceInstagramArgs{
	Configuration: &airbyte.SourceInstagramConfigurationArgs{
		AccessToken:  pulumi.String("string"),
		ClientId:     pulumi.String("string"),
		ClientSecret: pulumi.String("string"),
		NumWorkers:   pulumi.Float64(0),
		StartDate:    pulumi.String("string"),
	},
	WorkspaceId:  pulumi.String("string"),
	DefinitionId: pulumi.String("string"),
	Name:         pulumi.String("string"),
	SecretId:     pulumi.String("string"),
})
Copy
var sourceInstagramResource = new SourceInstagram("sourceInstagramResource", SourceInstagramArgs.builder()
    .configuration(SourceInstagramConfigurationArgs.builder()
        .accessToken("string")
        .clientId("string")
        .clientSecret("string")
        .numWorkers(0)
        .startDate("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());
Copy
source_instagram_resource = airbyte.SourceInstagram("sourceInstagramResource",
    configuration={
        "access_token": "string",
        "client_id": "string",
        "client_secret": "string",
        "num_workers": 0,
        "start_date": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")
Copy
const sourceInstagramResource = new airbyte.SourceInstagram("sourceInstagramResource", {
    configuration: {
        accessToken: "string",
        clientId: "string",
        clientSecret: "string",
        numWorkers: 0,
        startDate: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});
Copy
type: airbyte:SourceInstagram
properties:
    configuration:
        accessToken: string
        clientId: string
        clientSecret: string
        numWorkers: 0
        startDate: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string
Copy

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

Configuration This property is required. SourceInstagramConfiguration
WorkspaceId This property is required. 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 This property is required. SourceInstagramConfigurationArgs
WorkspaceId This property is required. 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 This property is required. SourceInstagramConfiguration
workspaceId This property is required. 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 This property is required. SourceInstagramConfiguration
workspaceId This property is required. 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 This property is required. SourceInstagramConfigurationArgs
workspace_id This property is required. 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 This property is required. Property Map
workspaceId This property is required. 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 SourceInstagram resource produces the following output properties:

CreatedAt double
Id string
The provider-assigned unique ID for this managed resource.
ResourceAllocation SourceInstagramResourceAllocation
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.
SourceId string
SourceType string
CreatedAt float64
Id string
The provider-assigned unique ID for this managed resource.
ResourceAllocation SourceInstagramResourceAllocation
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.
SourceId string
SourceType string
createdAt Double
id String
The provider-assigned unique ID for this managed resource.
resourceAllocation SourceInstagramResourceAllocation
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.
sourceId String
sourceType String
createdAt number
id string
The provider-assigned unique ID for this managed resource.
resourceAllocation SourceInstagramResourceAllocation
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.
sourceId string
sourceType string
created_at float
id str
The provider-assigned unique ID for this managed resource.
resource_allocation SourceInstagramResourceAllocation
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.
source_id str
source_type str
createdAt Number
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.
sourceId String
sourceType String

Look up Existing SourceInstagram Resource

Get an existing SourceInstagram 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?: SourceInstagramState, opts?: CustomResourceOptions): SourceInstagram
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourceInstagramConfigurationArgs] = None,
        created_at: Optional[float] = None,
        definition_id: Optional[str] = None,
        name: Optional[str] = None,
        resource_allocation: Optional[SourceInstagramResourceAllocationArgs] = None,
        secret_id: Optional[str] = None,
        source_id: Optional[str] = None,
        source_type: Optional[str] = None,
        workspace_id: Optional[str] = None) -> SourceInstagram
func GetSourceInstagram(ctx *Context, name string, id IDInput, state *SourceInstagramState, opts ...ResourceOption) (*SourceInstagram, error)
public static SourceInstagram Get(string name, Input<string> id, SourceInstagramState? state, CustomResourceOptions? opts = null)
public static SourceInstagram get(String name, Output<String> id, SourceInstagramState state, CustomResourceOptions options)
resources:  _:    type: airbyte:SourceInstagram    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 SourceInstagramConfiguration
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.
ResourceAllocation SourceInstagramResourceAllocation
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.
SecretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
SourceId string
SourceType string
WorkspaceId string
Configuration SourceInstagramConfigurationArgs
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.
ResourceAllocation SourceInstagramResourceAllocationArgs
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.
SecretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
SourceId string
SourceType string
WorkspaceId string
configuration SourceInstagramConfiguration
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.
resourceAllocation SourceInstagramResourceAllocation
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.
secretId String
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId String
sourceType String
workspaceId String
configuration SourceInstagramConfiguration
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.
resourceAllocation SourceInstagramResourceAllocation
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.
secretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId string
sourceType string
workspaceId string
configuration SourceInstagramConfigurationArgs
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.
resource_allocation SourceInstagramResourceAllocationArgs
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.
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.
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.
secretId String
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId String
sourceType String
workspaceId String

Supporting Types

SourceInstagramConfiguration
, SourceInstagramConfigurationArgs

AccessToken This property is required. string
The value of the access token generated with \n\ninstagrambasic, instagrammanageinsights, pagesshowlist, pagesread_engagement, Instagram Public Content Access\n\n permissions. See the \n\ndocs\n\n for more information
ClientId string
The Client ID for your Oauth application
ClientSecret string
The Client Secret for your Oauth application
NumWorkers double
The number of worker threads to use for the sync. Default: 15
StartDate string
The date from which you'd like to replicate data for User Insights, in the format YYYY-MM-DDT00:00:00Z. All data generated after this date will be replicated. If left blank, the start date will be set to 2 years before the present date.
AccessToken This property is required. string
The value of the access token generated with \n\ninstagrambasic, instagrammanageinsights, pagesshowlist, pagesread_engagement, Instagram Public Content Access\n\n permissions. See the \n\ndocs\n\n for more information
ClientId string
The Client ID for your Oauth application
ClientSecret string
The Client Secret for your Oauth application
NumWorkers float64
The number of worker threads to use for the sync. Default: 15
StartDate string
The date from which you'd like to replicate data for User Insights, in the format YYYY-MM-DDT00:00:00Z. All data generated after this date will be replicated. If left blank, the start date will be set to 2 years before the present date.
accessToken This property is required. String
The value of the access token generated with \n\ninstagrambasic, instagrammanageinsights, pagesshowlist, pagesread_engagement, Instagram Public Content Access\n\n permissions. See the \n\ndocs\n\n for more information
clientId String
The Client ID for your Oauth application
clientSecret String
The Client Secret for your Oauth application
numWorkers Double
The number of worker threads to use for the sync. Default: 15
startDate String
The date from which you'd like to replicate data for User Insights, in the format YYYY-MM-DDT00:00:00Z. All data generated after this date will be replicated. If left blank, the start date will be set to 2 years before the present date.
accessToken This property is required. string
The value of the access token generated with \n\ninstagrambasic, instagrammanageinsights, pagesshowlist, pagesread_engagement, Instagram Public Content Access\n\n permissions. See the \n\ndocs\n\n for more information
clientId string
The Client ID for your Oauth application
clientSecret string
The Client Secret for your Oauth application
numWorkers number
The number of worker threads to use for the sync. Default: 15
startDate string
The date from which you'd like to replicate data for User Insights, in the format YYYY-MM-DDT00:00:00Z. All data generated after this date will be replicated. If left blank, the start date will be set to 2 years before the present date.
access_token This property is required. str
The value of the access token generated with \n\ninstagrambasic, instagrammanageinsights, pagesshowlist, pagesread_engagement, Instagram Public Content Access\n\n permissions. See the \n\ndocs\n\n for more information
client_id str
The Client ID for your Oauth application
client_secret str
The Client Secret for your Oauth application
num_workers float
The number of worker threads to use for the sync. Default: 15
start_date str
The date from which you'd like to replicate data for User Insights, in the format YYYY-MM-DDT00:00:00Z. All data generated after this date will be replicated. If left blank, the start date will be set to 2 years before the present date.
accessToken This property is required. String
The value of the access token generated with \n\ninstagrambasic, instagrammanageinsights, pagesshowlist, pagesread_engagement, Instagram Public Content Access\n\n permissions. See the \n\ndocs\n\n for more information
clientId String
The Client ID for your Oauth application
clientSecret String
The Client Secret for your Oauth application
numWorkers Number
The number of worker threads to use for the sync. Default: 15
startDate String
The date from which you'd like to replicate data for User Insights, in the format YYYY-MM-DDT00:00:00Z. All data generated after this date will be replicated. If left blank, the start date will be set to 2 years before the present date.

SourceInstagramResourceAllocation
, SourceInstagramResourceAllocationArgs

Default SourceInstagramResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
JobSpecifics List<SourceInstagramResourceAllocationJobSpecific>
Default SourceInstagramResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
JobSpecifics []SourceInstagramResourceAllocationJobSpecific
default_ SourceInstagramResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics List<SourceInstagramResourceAllocationJobSpecific>
default SourceInstagramResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics SourceInstagramResourceAllocationJobSpecific[]
default SourceInstagramResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
job_specifics Sequence[SourceInstagramResourceAllocationJobSpecific]
default Property Map
optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics List<Property Map>

SourceInstagramResourceAllocationDefault
, SourceInstagramResourceAllocationDefaultArgs

SourceInstagramResourceAllocationJobSpecific
, SourceInstagramResourceAllocationJobSpecificArgs

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 SourceInstagramResourceAllocationJobSpecificResourceRequirements
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 SourceInstagramResourceAllocationJobSpecificResourceRequirements
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 SourceInstagramResourceAllocationJobSpecificResourceRequirements
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 SourceInstagramResourceAllocationJobSpecificResourceRequirements
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 SourceInstagramResourceAllocationJobSpecificResourceRequirements
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)

SourceInstagramResourceAllocationJobSpecificResourceRequirements
, SourceInstagramResourceAllocationJobSpecificResourceRequirementsArgs

Import

$ pulumi import airbyte:index/sourceInstagram:SourceInstagram my_airbyte_source_instagram ""
Copy

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.