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

airbyte.SourceZohoBigin

Explore with Pulumi AI

SourceZohoBigin 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.SourceZohoBigin;
import com.pulumi.airbyte.SourceZohoBiginArgs;
import com.pulumi.airbyte.inputs.SourceZohoBiginConfigurationArgs;
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 mySourceZohobigin = new SourceZohoBigin("mySourceZohobigin", SourceZohoBiginArgs.builder()
            .configuration(SourceZohoBiginConfigurationArgs.builder()
                .client_id("...my_client_id...")
                .client_refresh_token("...my_client_refresh_token...")
                .client_secret("...my_client_secret...")
                .data_center("com")
                .module_name("...my_module_name...")
                .build())
            .definitionId("59bc2da0-0bbf-4ae2-ad4e-256d27313bbf")
            .secretId("...my_secret_id...")
            .workspaceId("810238c0-f7ad-475c-a093-f1a5f05c3712")
            .build());

    }
}
Copy
resources:
  mySourceZohobigin:
    type: airbyte:SourceZohoBigin
    properties:
      configuration:
        client_id: '...my_client_id...'
        client_refresh_token: '...my_client_refresh_token...'
        client_secret: '...my_client_secret...'
        data_center: com
        module_name: '...my_module_name...'
      definitionId: 59bc2da0-0bbf-4ae2-ad4e-256d27313bbf
      secretId: '...my_secret_id...'
      workspaceId: 810238c0-f7ad-475c-a093-f1a5f05c3712
Copy

Create SourceZohoBigin Resource

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

Constructor syntax

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

@overload
def SourceZohoBigin(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    configuration: Optional[SourceZohoBiginConfigurationArgs] = None,
                    workspace_id: Optional[str] = None,
                    definition_id: Optional[str] = None,
                    name: Optional[str] = None,
                    secret_id: Optional[str] = None)
func NewSourceZohoBigin(ctx *Context, name string, args SourceZohoBiginArgs, opts ...ResourceOption) (*SourceZohoBigin, error)
public SourceZohoBigin(string name, SourceZohoBiginArgs args, CustomResourceOptions? opts = null)
public SourceZohoBigin(String name, SourceZohoBiginArgs args)
public SourceZohoBigin(String name, SourceZohoBiginArgs args, CustomResourceOptions options)
type: airbyte:SourceZohoBigin
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. SourceZohoBiginArgs
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. SourceZohoBiginArgs
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. SourceZohoBiginArgs
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. SourceZohoBiginArgs
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. SourceZohoBiginArgs
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 sourceZohoBiginResource = new Airbyte.SourceZohoBigin("sourceZohoBiginResource", new()
{
    Configuration = new Airbyte.Inputs.SourceZohoBiginConfigurationArgs
    {
        ClientId = "string",
        ClientRefreshToken = "string",
        ClientSecret = "string",
        ModuleName = "string",
        DataCenter = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});
Copy
example, err := airbyte.NewSourceZohoBigin(ctx, "sourceZohoBiginResource", &airbyte.SourceZohoBiginArgs{
Configuration: &.SourceZohoBiginConfigurationArgs{
ClientId: pulumi.String("string"),
ClientRefreshToken: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
ModuleName: pulumi.String("string"),
DataCenter: pulumi.String("string"),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})
Copy
var sourceZohoBiginResource = new SourceZohoBigin("sourceZohoBiginResource", SourceZohoBiginArgs.builder()
    .configuration(SourceZohoBiginConfigurationArgs.builder()
        .clientId("string")
        .clientRefreshToken("string")
        .clientSecret("string")
        .moduleName("string")
        .dataCenter("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());
Copy
source_zoho_bigin_resource = airbyte.SourceZohoBigin("sourceZohoBiginResource",
    configuration={
        "client_id": "string",
        "client_refresh_token": "string",
        "client_secret": "string",
        "module_name": "string",
        "data_center": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")
Copy
const sourceZohoBiginResource = new airbyte.SourceZohoBigin("sourceZohoBiginResource", {
    configuration: {
        clientId: "string",
        clientRefreshToken: "string",
        clientSecret: "string",
        moduleName: "string",
        dataCenter: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});
Copy
type: airbyte:SourceZohoBigin
properties:
    configuration:
        clientId: string
        clientRefreshToken: string
        clientSecret: string
        dataCenter: string
        moduleName: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string
Copy

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

Configuration This property is required. SourceZohoBiginConfiguration
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. SourceZohoBiginConfigurationArgs
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. SourceZohoBiginConfiguration
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. SourceZohoBiginConfiguration
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. SourceZohoBiginConfigurationArgs
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 SourceZohoBigin resource produces the following output properties:

CreatedAt double
Id string
The provider-assigned unique ID for this managed resource.
ResourceAllocation SourceZohoBiginResourceAllocation
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 SourceZohoBiginResourceAllocation
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 SourceZohoBiginResourceAllocation
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 SourceZohoBiginResourceAllocation
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 SourceZohoBiginResourceAllocation
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 SourceZohoBigin Resource

Get an existing SourceZohoBigin 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?: SourceZohoBiginState, opts?: CustomResourceOptions): SourceZohoBigin
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourceZohoBiginConfigurationArgs] = None,
        created_at: Optional[float] = None,
        definition_id: Optional[str] = None,
        name: Optional[str] = None,
        resource_allocation: Optional[SourceZohoBiginResourceAllocationArgs] = None,
        secret_id: Optional[str] = None,
        source_id: Optional[str] = None,
        source_type: Optional[str] = None,
        workspace_id: Optional[str] = None) -> SourceZohoBigin
func GetSourceZohoBigin(ctx *Context, name string, id IDInput, state *SourceZohoBiginState, opts ...ResourceOption) (*SourceZohoBigin, error)
public static SourceZohoBigin Get(string name, Input<string> id, SourceZohoBiginState? state, CustomResourceOptions? opts = null)
public static SourceZohoBigin get(String name, Output<String> id, SourceZohoBiginState state, CustomResourceOptions options)
resources:  _:    type: airbyte:SourceZohoBigin    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 SourceZohoBiginConfiguration
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 SourceZohoBiginResourceAllocation
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 SourceZohoBiginConfigurationArgs
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 SourceZohoBiginResourceAllocationArgs
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 SourceZohoBiginConfiguration
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 SourceZohoBiginResourceAllocation
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 SourceZohoBiginConfiguration
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 SourceZohoBiginResourceAllocation
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 SourceZohoBiginConfigurationArgs
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 SourceZohoBiginResourceAllocationArgs
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

SourceZohoBiginConfiguration
, SourceZohoBiginConfigurationArgs

ClientId This property is required. string
ClientRefreshToken This property is required. string
ClientSecret This property is required. string
ModuleName This property is required. string
DataCenter string
The data center where the Bigin account's resources are hosted. Default: "com"; must be one of ["com", "com.au", "eu", "in", "com.cn", "jp"]
ClientId This property is required. string
ClientRefreshToken This property is required. string
ClientSecret This property is required. string
ModuleName This property is required. string
DataCenter string
The data center where the Bigin account's resources are hosted. Default: "com"; must be one of ["com", "com.au", "eu", "in", "com.cn", "jp"]
clientId This property is required. String
clientRefreshToken This property is required. String
clientSecret This property is required. String
moduleName This property is required. String
dataCenter String
The data center where the Bigin account's resources are hosted. Default: "com"; must be one of ["com", "com.au", "eu", "in", "com.cn", "jp"]
clientId This property is required. string
clientRefreshToken This property is required. string
clientSecret This property is required. string
moduleName This property is required. string
dataCenter string
The data center where the Bigin account's resources are hosted. Default: "com"; must be one of ["com", "com.au", "eu", "in", "com.cn", "jp"]
client_id This property is required. str
client_refresh_token This property is required. str
client_secret This property is required. str
module_name This property is required. str
data_center str
The data center where the Bigin account's resources are hosted. Default: "com"; must be one of ["com", "com.au", "eu", "in", "com.cn", "jp"]
clientId This property is required. String
clientRefreshToken This property is required. String
clientSecret This property is required. String
moduleName This property is required. String
dataCenter String
The data center where the Bigin account's resources are hosted. Default: "com"; must be one of ["com", "com.au", "eu", "in", "com.cn", "jp"]

SourceZohoBiginResourceAllocation
, SourceZohoBiginResourceAllocationArgs

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

SourceZohoBiginResourceAllocationDefault
, SourceZohoBiginResourceAllocationDefaultArgs

SourceZohoBiginResourceAllocationJobSpecific
, SourceZohoBiginResourceAllocationJobSpecificArgs

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

SourceZohoBiginResourceAllocationJobSpecificResourceRequirements
, SourceZohoBiginResourceAllocationJobSpecificResourceRequirementsArgs

Import

$ pulumi import airbyte:index/sourceZohoBigin:SourceZohoBigin my_airbyte_source_zoho_bigin ""
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.