1. Packages
  2. Airbyte Provider
  3. API Docs
  4. SourceCimis
airbyte 0.9.0 published on Wednesday, Apr 9, 2025 by airbytehq

airbyte.SourceCimis

Explore with Pulumi AI

SourceCimis 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.SourceCimis;
import com.pulumi.airbyte.SourceCimisArgs;
import com.pulumi.airbyte.inputs.SourceCimisConfigurationArgs;
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 mySourceCimis = new SourceCimis("mySourceCimis", SourceCimisArgs.builder()
            .configuration(SourceCimisConfigurationArgs.builder()
                .api_key("...my_api_key...")
                .daily_data_items("{ \"see\": \"documentation\" }")
                .end_date("2020-09-27T05:27:28.289Z")
                .hourly_data_items("{ \"see\": \"documentation\" }")
                .start_date("2021-04-23T12:14:10.894Z")
                .targets("{ \"see\": \"documentation\" }")
                .targets_type("California zip codes")
                .unit_of_measure("E")
                .build())
            .definitionId("58ad382d-b84b-4901-9270-1ea4e0d67c63")
            .secretId("...my_secret_id...")
            .workspaceId("7a77ac9a-00d4-4975-8d98-cec7c9a9a112")
            .build());

    }
}
Copy
resources:
  mySourceCimis:
    type: airbyte:SourceCimis
    properties:
      configuration:
        api_key: '...my_api_key...'
        daily_data_items:
          - '{ "see": "documentation" }'
        end_date: 2020-09-27T05:27:28.289Z
        hourly_data_items:
          - '{ "see": "documentation" }'
        start_date: 2021-04-23T12:14:10.894Z
        targets:
          - '{ "see": "documentation" }'
        targets_type: California zip codes
        unit_of_measure: E
      definitionId: 58ad382d-b84b-4901-9270-1ea4e0d67c63
      secretId: '...my_secret_id...'
      workspaceId: 7a77ac9a-00d4-4975-8d98-cec7c9a9a112
Copy

Create SourceCimis Resource

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

Constructor syntax

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

@overload
def SourceCimis(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                configuration: Optional[SourceCimisConfigurationArgs] = None,
                workspace_id: Optional[str] = None,
                definition_id: Optional[str] = None,
                name: Optional[str] = None,
                secret_id: Optional[str] = None)
func NewSourceCimis(ctx *Context, name string, args SourceCimisArgs, opts ...ResourceOption) (*SourceCimis, error)
public SourceCimis(string name, SourceCimisArgs args, CustomResourceOptions? opts = null)
public SourceCimis(String name, SourceCimisArgs args)
public SourceCimis(String name, SourceCimisArgs args, CustomResourceOptions options)
type: airbyte:SourceCimis
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. SourceCimisArgs
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. SourceCimisArgs
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. SourceCimisArgs
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. SourceCimisArgs
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. SourceCimisArgs
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 sourceCimisResource = new Airbyte.SourceCimis("sourceCimisResource", new()
{
    Configuration = new Airbyte.Inputs.SourceCimisConfigurationArgs
    {
        ApiKey = "string",
        EndDate = "string",
        StartDate = "string",
        Targets = new[]
        {
            "string",
        },
        TargetsType = "string",
        DailyDataItems = new[]
        {
            "string",
        },
        HourlyDataItems = new[]
        {
            "string",
        },
        UnitOfMeasure = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});
Copy
example, err := airbyte.NewSourceCimis(ctx, "sourceCimisResource", &airbyte.SourceCimisArgs{
Configuration: &.SourceCimisConfigurationArgs{
ApiKey: pulumi.String("string"),
EndDate: pulumi.String("string"),
StartDate: pulumi.String("string"),
Targets: pulumi.StringArray{
pulumi.String("string"),
},
TargetsType: pulumi.String("string"),
DailyDataItems: pulumi.StringArray{
pulumi.String("string"),
},
HourlyDataItems: pulumi.StringArray{
pulumi.String("string"),
},
UnitOfMeasure: pulumi.String("string"),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})
Copy
var sourceCimisResource = new SourceCimis("sourceCimisResource", SourceCimisArgs.builder()
    .configuration(SourceCimisConfigurationArgs.builder()
        .apiKey("string")
        .endDate("string")
        .startDate("string")
        .targets("string")
        .targetsType("string")
        .dailyDataItems("string")
        .hourlyDataItems("string")
        .unitOfMeasure("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());
Copy
source_cimis_resource = airbyte.SourceCimis("sourceCimisResource",
    configuration={
        "api_key": "string",
        "end_date": "string",
        "start_date": "string",
        "targets": ["string"],
        "targets_type": "string",
        "daily_data_items": ["string"],
        "hourly_data_items": ["string"],
        "unit_of_measure": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")
Copy
const sourceCimisResource = new airbyte.SourceCimis("sourceCimisResource", {
    configuration: {
        apiKey: "string",
        endDate: "string",
        startDate: "string",
        targets: ["string"],
        targetsType: "string",
        dailyDataItems: ["string"],
        hourlyDataItems: ["string"],
        unitOfMeasure: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});
Copy
type: airbyte:SourceCimis
properties:
    configuration:
        apiKey: string
        dailyDataItems:
            - string
        endDate: string
        hourlyDataItems:
            - string
        startDate: string
        targets:
            - string
        targetsType: string
        unitOfMeasure: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string
Copy

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

Configuration This property is required. SourceCimisConfiguration
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. SourceCimisConfigurationArgs
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. SourceCimisConfiguration
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. SourceCimisConfiguration
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. SourceCimisConfigurationArgs
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 SourceCimis resource produces the following output properties:

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

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

SourceCimisConfiguration
, SourceCimisConfigurationArgs

ApiKey This property is required. string
EndDate This property is required. string
StartDate This property is required. string
Targets This property is required. List<string>
TargetsType This property is required. string
must be one of ["WSN station numbers", "California zip codes", "decimal-degree coordinates", "street addresses"]
DailyDataItems List<string>
HourlyDataItems List<string>
UnitOfMeasure string
must be one of ["E", "M"]
ApiKey This property is required. string
EndDate This property is required. string
StartDate This property is required. string
Targets This property is required. []string
TargetsType This property is required. string
must be one of ["WSN station numbers", "California zip codes", "decimal-degree coordinates", "street addresses"]
DailyDataItems []string
HourlyDataItems []string
UnitOfMeasure string
must be one of ["E", "M"]
apiKey This property is required. String
endDate This property is required. String
startDate This property is required. String
targets This property is required. List<String>
targetsType This property is required. String
must be one of ["WSN station numbers", "California zip codes", "decimal-degree coordinates", "street addresses"]
dailyDataItems List<String>
hourlyDataItems List<String>
unitOfMeasure String
must be one of ["E", "M"]
apiKey This property is required. string
endDate This property is required. string
startDate This property is required. string
targets This property is required. string[]
targetsType This property is required. string
must be one of ["WSN station numbers", "California zip codes", "decimal-degree coordinates", "street addresses"]
dailyDataItems string[]
hourlyDataItems string[]
unitOfMeasure string
must be one of ["E", "M"]
api_key This property is required. str
end_date This property is required. str
start_date This property is required. str
targets This property is required. Sequence[str]
targets_type This property is required. str
must be one of ["WSN station numbers", "California zip codes", "decimal-degree coordinates", "street addresses"]
daily_data_items Sequence[str]
hourly_data_items Sequence[str]
unit_of_measure str
must be one of ["E", "M"]
apiKey This property is required. String
endDate This property is required. String
startDate This property is required. String
targets This property is required. List<String>
targetsType This property is required. String
must be one of ["WSN station numbers", "California zip codes", "decimal-degree coordinates", "street addresses"]
dailyDataItems List<String>
hourlyDataItems List<String>
unitOfMeasure String
must be one of ["E", "M"]

SourceCimisResourceAllocation
, SourceCimisResourceAllocationArgs

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

SourceCimisResourceAllocationDefault
, SourceCimisResourceAllocationDefaultArgs

SourceCimisResourceAllocationJobSpecific
, SourceCimisResourceAllocationJobSpecificArgs

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

SourceCimisResourceAllocationJobSpecificResourceRequirements
, SourceCimisResourceAllocationJobSpecificResourceRequirementsArgs

Import

$ pulumi import airbyte:index/sourceCimis:SourceCimis my_airbyte_source_cimis ""
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.