Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Airbyte Provider
  3. API Docs
  4. SourceAgilecrm
airbyte 0.9.0 published on Wednesday, Apr 9, 2025 by airbytehq
airbytehq/terraform-provider-airbyte

airbyte.SourceAgilecrm

Explore with Pulumi AI

airbyte 0.9.0 published on Wednesday, Apr 9, 2025 by airbytehq
airbytehq/terraform-provider-airbyte

SourceAgilecrm 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.SourceAgilecrm;
import com.pulumi.airbyte.SourceAgilecrmArgs;
import com.pulumi.airbyte.inputs.SourceAgilecrmConfigurationArgs;
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 mySourceAgilecrm = new SourceAgilecrm("mySourceAgilecrm", SourceAgilecrmArgs.builder()
            .configuration(SourceAgilecrmConfigurationArgs.builder()
                .api_key("...my_api_key...")
                .domain("...my_domain...")
                .email("...my_email...")
                .build())
            .definitionId("0f0e09bf-f2a4-41eb-8f71-416741020723")
            .secretId("...my_secret_id...")
            .workspaceId("0054785a-0f86-43a0-897d-e5aca7bc2d9e")
            .build());

    }
}
Copy
resources:
  mySourceAgilecrm:
    type: airbyte:SourceAgilecrm
    properties:
      configuration:
        api_key: '...my_api_key...'
        domain: '...my_domain...'
        email: '...my_email...'
      definitionId: 0f0e09bf-f2a4-41eb-8f71-416741020723
      secretId: '...my_secret_id...'
      workspaceId: 0054785a-0f86-43a0-897d-e5aca7bc2d9e
Copy

Create SourceAgilecrm Resource

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

Constructor syntax

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

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

type: airbyte:SourceAgilecrm
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. SourceAgilecrmArgs
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. SourceAgilecrmArgs
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. SourceAgilecrmArgs
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. SourceAgilecrmArgs
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. SourceAgilecrmArgs
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 sourceAgilecrmResource = new Airbyte.SourceAgilecrm("sourceAgilecrmResource", new()
{
    Configuration = new Airbyte.Inputs.SourceAgilecrmConfigurationArgs
    {
        ApiKey = "string",
        Domain = "string",
        Email = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});
Copy
example, err := airbyte.NewSourceAgilecrm(ctx, "sourceAgilecrmResource", &airbyte.SourceAgilecrmArgs{
Configuration: &.SourceAgilecrmConfigurationArgs{
ApiKey: pulumi.String("string"),
Domain: pulumi.String("string"),
Email: pulumi.String("string"),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})
Copy
var sourceAgilecrmResource = new SourceAgilecrm("sourceAgilecrmResource", SourceAgilecrmArgs.builder()
    .configuration(SourceAgilecrmConfigurationArgs.builder()
        .apiKey("string")
        .domain("string")
        .email("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());
Copy
source_agilecrm_resource = airbyte.SourceAgilecrm("sourceAgilecrmResource",
    configuration={
        "api_key": "string",
        "domain": "string",
        "email": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")
Copy
const sourceAgilecrmResource = new airbyte.SourceAgilecrm("sourceAgilecrmResource", {
    configuration: {
        apiKey: "string",
        domain: "string",
        email: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});
Copy
type: airbyte:SourceAgilecrm
properties:
    configuration:
        apiKey: string
        domain: string
        email: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string
Copy

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

Configuration This property is required. SourceAgilecrmConfiguration
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. SourceAgilecrmConfigurationArgs
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. SourceAgilecrmConfiguration
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. SourceAgilecrmConfiguration
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. SourceAgilecrmConfigurationArgs
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 SourceAgilecrm resource produces the following output properties:

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

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

SourceAgilecrmConfiguration
, SourceAgilecrmConfigurationArgs

ApiKey This property is required. string
API key to use. Find it at Admin Settings > API & Analytics > API Key in your Agile CRM account.
Domain This property is required. string
The specific subdomain for your Agile CRM account
Email This property is required. string
Your Agile CRM account email address. This is used as the username for authentication.
ApiKey This property is required. string
API key to use. Find it at Admin Settings > API & Analytics > API Key in your Agile CRM account.
Domain This property is required. string
The specific subdomain for your Agile CRM account
Email This property is required. string
Your Agile CRM account email address. This is used as the username for authentication.
apiKey This property is required. String
API key to use. Find it at Admin Settings > API & Analytics > API Key in your Agile CRM account.
domain This property is required. String
The specific subdomain for your Agile CRM account
email This property is required. String
Your Agile CRM account email address. This is used as the username for authentication.
apiKey This property is required. string
API key to use. Find it at Admin Settings > API & Analytics > API Key in your Agile CRM account.
domain This property is required. string
The specific subdomain for your Agile CRM account
email This property is required. string
Your Agile CRM account email address. This is used as the username for authentication.
api_key This property is required. str
API key to use. Find it at Admin Settings > API & Analytics > API Key in your Agile CRM account.
domain This property is required. str
The specific subdomain for your Agile CRM account
email This property is required. str
Your Agile CRM account email address. This is used as the username for authentication.
apiKey This property is required. String
API key to use. Find it at Admin Settings > API & Analytics > API Key in your Agile CRM account.
domain This property is required. String
The specific subdomain for your Agile CRM account
email This property is required. String
Your Agile CRM account email address. This is used as the username for authentication.

SourceAgilecrmResourceAllocation
, SourceAgilecrmResourceAllocationArgs

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

SourceAgilecrmResourceAllocationDefault
, SourceAgilecrmResourceAllocationDefaultArgs

SourceAgilecrmResourceAllocationJobSpecific
, SourceAgilecrmResourceAllocationJobSpecificArgs

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

SourceAgilecrmResourceAllocationJobSpecificResourceRequirements
, SourceAgilecrmResourceAllocationJobSpecificResourceRequirementsArgs

Import

$ pulumi import airbyte:index/sourceAgilecrm:SourceAgilecrm my_airbyte_source_agilecrm ""
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.
airbyte 0.9.0 published on Wednesday, Apr 9, 2025 by airbytehq
airbytehq/terraform-provider-airbyte