airbyte 0.7.0-beta2, Mar 7 25

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

airbyte.SourceZohoCrm

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.SourceZohoCrm;
import com.pulumi.airbyte.SourceZohoCrmArgs;
import com.pulumi.airbyte.inputs.SourceZohoCrmConfigurationArgs;
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 mySourceZohocrm = new SourceZohoCrm("mySourceZohocrm", SourceZohoCrmArgs.builder()
            .configuration(SourceZohoCrmConfigurationArgs.builder()
                .client_id("...my_client_id...")
                .client_secret("...my_client_secret...")
                .dc_region("EU")
                .edition("Professional")
                .environment("Developer")
                .refresh_token("...my_refresh_token...")
                .start_datetime("2000-01-01")
                .build())
            .definitionId("e74e0328-b159-45d6-af04-f64ce40616cc")
            .secretId("...my_secret_id...")
            .workspaceId("f80b4296-5ba4-4f22-a9e0-b04a62eca8b6")
            .build());

    }
}

resources:
  mySourceZohocrm:
    type: airbyte:SourceZohoCrm
    properties:
      configuration:
        client_id: '...my_client_id...'
        client_secret: '...my_client_secret...'
        dc_region: EU
        edition: Professional
        environment: Developer
        refresh_token: '...my_refresh_token...'
        start_datetime: 2000-01-01
      definitionId: e74e0328-b159-45d6-af04-f64ce40616cc
      secretId: '...my_secret_id...'
      workspaceId: f80b4296-5ba4-4f22-a9e0-b04a62eca8b6

Create SourceZohoCrm Resource

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

Constructor syntax

new SourceZohoCrm(name: string, args: SourceZohoCrmArgs, opts?: CustomResourceOptions);

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

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

func NewSourceZohoCrm(ctx *Context, name string, args SourceZohoCrmArgs, opts ...ResourceOption) (*SourceZohoCrm, error)

public SourceZohoCrm(string name, SourceZohoCrmArgs args, CustomResourceOptions? opts = null)

public SourceZohoCrm(String name, SourceZohoCrmArgs args)
public SourceZohoCrm(String name, SourceZohoCrmArgs args, CustomResourceOptions options)

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

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

name String: The unique name of the resource.
args SourceZohoCrmArgs: 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 sourceZohoCrmResource = new Airbyte.SourceZohoCrm("sourceZohoCrmResource", new()
{
    Configuration = new Airbyte.Inputs.SourceZohoCrmConfigurationArgs
    {
        ClientId = "string",
        ClientSecret = "string",
        DcRegion = "string",
        Environment = "string",
        RefreshToken = "string",
        Edition = "string",
        StartDatetime = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});

example, err := airbyte.NewSourceZohoCrm(ctx, "sourceZohoCrmResource", &airbyte.SourceZohoCrmArgs{
Configuration: &.SourceZohoCrmConfigurationArgs{
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
DcRegion: pulumi.String("string"),
Environment: pulumi.String("string"),
RefreshToken: pulumi.String("string"),
Edition: pulumi.String("string"),
StartDatetime: pulumi.String("string"),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})

var sourceZohoCrmResource = new SourceZohoCrm("sourceZohoCrmResource", SourceZohoCrmArgs.builder()
    .configuration(SourceZohoCrmConfigurationArgs.builder()
        .clientId("string")
        .clientSecret("string")
        .dcRegion("string")
        .environment("string")
        .refreshToken("string")
        .edition("string")
        .startDatetime("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());

source_zoho_crm_resource = airbyte.SourceZohoCrm("sourceZohoCrmResource",
    configuration={
        "client_id": "string",
        "client_secret": "string",
        "dc_region": "string",
        "environment": "string",
        "refresh_token": "string",
        "edition": "string",
        "start_datetime": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")

const sourceZohoCrmResource = new airbyte.SourceZohoCrm("sourceZohoCrmResource", {
    configuration: {
        clientId: "string",
        clientSecret: "string",
        dcRegion: "string",
        environment: "string",
        refreshToken: "string",
        edition: "string",
        startDatetime: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});

type: airbyte:SourceZohoCrm
properties:
    configuration:
        clientId: string
        clientSecret: string
        dcRegion: string
        edition: string
        environment: string
        refreshToken: string
        startDatetime: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string

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

Configuration SourceZohoCrmConfiguration
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 SourceZohoCrmConfigurationArgs
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 SourceZohoCrmConfiguration
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 SourceZohoCrmConfiguration
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 SourceZohoCrmConfigurationArgs
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 SourceZohoCrm 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 SourceZohoCrm Resource

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

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

func GetSourceZohoCrm(ctx *Context, name string, id IDInput, state *SourceZohoCrmState, opts ...ResourceOption) (*SourceZohoCrm, error)

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

public static SourceZohoCrm get(String name, Output<String> id, SourceZohoCrmState state, CustomResourceOptions options)

resources:  _:    type: airbyte:SourceZohoCrm    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 SourceZohoCrmConfiguration
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 SourceZohoCrmConfigurationArgs
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 SourceZohoCrmConfiguration
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 SourceZohoCrmConfiguration
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 SourceZohoCrmConfigurationArgs
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

SourceZohoCrmConfiguration, SourceZohoCrmConfigurationArgs

ClientId string: OAuth2.0 Client ID
ClientSecret string: OAuth2.0 Client Secret
DcRegion string: Please choose the region of your Data Center location. More info by this \n\nLink\n\n. must be one of ["US", "AU", "EU", "IN", "CN", "JP"]
Environment string: Please choose the environment. must be one of ["Production", "Developer", "Sandbox"]
RefreshToken string: OAuth2.0 Refresh Token
Edition string: Choose your Edition of Zoho CRM to determine API Concurrency Limits. Default: "Free"; must be one of ["Free", "Standard", "Professional", "Enterprise", "Ultimate"]
StartDatetime string: ISO 8601, for instance: YYYY-MM-DD, YYYY-MM-DD HH:MM:SS+HH:MM

ClientId string: OAuth2.0 Client ID
ClientSecret string: OAuth2.0 Client Secret
DcRegion string: Please choose the region of your Data Center location. More info by this \n\nLink\n\n. must be one of ["US", "AU", "EU", "IN", "CN", "JP"]
Environment string: Please choose the environment. must be one of ["Production", "Developer", "Sandbox"]
RefreshToken string: OAuth2.0 Refresh Token
Edition string: Choose your Edition of Zoho CRM to determine API Concurrency Limits. Default: "Free"; must be one of ["Free", "Standard", "Professional", "Enterprise", "Ultimate"]
StartDatetime string: ISO 8601, for instance: YYYY-MM-DD, YYYY-MM-DD HH:MM:SS+HH:MM

clientId String: OAuth2.0 Client ID
clientSecret String: OAuth2.0 Client Secret
dcRegion String: Please choose the region of your Data Center location. More info by this \n\nLink\n\n. must be one of ["US", "AU", "EU", "IN", "CN", "JP"]
environment String: Please choose the environment. must be one of ["Production", "Developer", "Sandbox"]
refreshToken String: OAuth2.0 Refresh Token
edition String: Choose your Edition of Zoho CRM to determine API Concurrency Limits. Default: "Free"; must be one of ["Free", "Standard", "Professional", "Enterprise", "Ultimate"]
startDatetime String: ISO 8601, for instance: YYYY-MM-DD, YYYY-MM-DD HH:MM:SS+HH:MM

clientId string: OAuth2.0 Client ID
clientSecret string: OAuth2.0 Client Secret
dcRegion string: Please choose the region of your Data Center location. More info by this \n\nLink\n\n. must be one of ["US", "AU", "EU", "IN", "CN", "JP"]
environment string: Please choose the environment. must be one of ["Production", "Developer", "Sandbox"]
refreshToken string: OAuth2.0 Refresh Token
edition string: Choose your Edition of Zoho CRM to determine API Concurrency Limits. Default: "Free"; must be one of ["Free", "Standard", "Professional", "Enterprise", "Ultimate"]
startDatetime string: ISO 8601, for instance: YYYY-MM-DD, YYYY-MM-DD HH:MM:SS+HH:MM

client_id str: OAuth2.0 Client ID
client_secret str: OAuth2.0 Client Secret
dc_region str: Please choose the region of your Data Center location. More info by this \n\nLink\n\n. must be one of ["US", "AU", "EU", "IN", "CN", "JP"]
environment str: Please choose the environment. must be one of ["Production", "Developer", "Sandbox"]
refresh_token str: OAuth2.0 Refresh Token
edition str: Choose your Edition of Zoho CRM to determine API Concurrency Limits. Default: "Free"; must be one of ["Free", "Standard", "Professional", "Enterprise", "Ultimate"]
start_datetime str: ISO 8601, for instance: YYYY-MM-DD, YYYY-MM-DD HH:MM:SS+HH:MM

clientId String: OAuth2.0 Client ID
clientSecret String: OAuth2.0 Client Secret
dcRegion String: Please choose the region of your Data Center location. More info by this \n\nLink\n\n. must be one of ["US", "AU", "EU", "IN", "CN", "JP"]
environment String: Please choose the environment. must be one of ["Production", "Developer", "Sandbox"]
refreshToken String: OAuth2.0 Refresh Token
edition String: Choose your Edition of Zoho CRM to determine API Concurrency Limits. Default: "Free"; must be one of ["Free", "Standard", "Professional", "Enterprise", "Ultimate"]
startDatetime String: ISO 8601, for instance: YYYY-MM-DD, YYYY-MM-DD HH:MM:SS+HH:MM

Import

$ pulumi import airbyte:index/sourceZohoCrm:SourceZohoCrm my_airbyte_source_zoho_crm ""

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

On this page

On this page

Example Usage

Create SourceZohoCrm Resource

Constructor syntax

Parameters

Constructor example

SourceZohoCrm Resource Properties

Inputs

Outputs

Look up Existing SourceZohoCrm Resource

Supporting Types

SourceZohoCrmConfiguration, SourceZohoCrmConfigurationArgs

Import

Package Details

On this page

On this page