airbyte 0.7.0-beta2, Mar 7 25

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

airbyte.SourceCoinApi

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.SourceCoinApi;
import com.pulumi.airbyte.SourceCoinApiArgs;
import com.pulumi.airbyte.inputs.SourceCoinApiConfigurationArgs;
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 mySourceCoinapi = new SourceCoinApi("mySourceCoinapi", SourceCoinApiArgs.builder()
            .configuration(SourceCoinApiConfigurationArgs.builder()
                .api_key("...my_api_key...")
                .end_date("2019-01-01T00:00:00")
                .environment("sandbox")
                .limit(39021)
                .period("5SEC")
                .start_date("2019-01-01T00:00:00")
                .symbol_id("...my_symbol_id...")
                .build())
            .definitionId("bddfa872-3b12-4feb-a665-3aa5aa88bcb2")
            .secretId("...my_secret_id...")
            .workspaceId("0929de6e-00e3-4d8c-81a1-849a2ab68cdb")
            .build());

    }
}

resources:
  mySourceCoinapi:
    type: airbyte:SourceCoinApi
    properties:
      configuration:
        api_key: '...my_api_key...'
        end_date: 2019-01-01T00:00:00
        environment: sandbox
        limit: 39021
        period: 5SEC
        start_date: 2019-01-01T00:00:00
        symbol_id: '...my_symbol_id...'
      definitionId: bddfa872-3b12-4feb-a665-3aa5aa88bcb2
      secretId: '...my_secret_id...'
      workspaceId: 0929de6e-00e3-4d8c-81a1-849a2ab68cdb

Create SourceCoinApi Resource

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

Constructor syntax

new SourceCoinApi(name: string, args: SourceCoinApiArgs, opts?: CustomResourceOptions);

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

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

func NewSourceCoinApi(ctx *Context, name string, args SourceCoinApiArgs, opts ...ResourceOption) (*SourceCoinApi, error)

public SourceCoinApi(string name, SourceCoinApiArgs args, CustomResourceOptions? opts = null)

public SourceCoinApi(String name, SourceCoinApiArgs args)
public SourceCoinApi(String name, SourceCoinApiArgs args, CustomResourceOptions options)

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

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

name String: The unique name of the resource.
args SourceCoinApiArgs: 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 sourceCoinApiResource = new Airbyte.SourceCoinApi("sourceCoinApiResource", new()
{
    Configuration = new Airbyte.Inputs.SourceCoinApiConfigurationArgs
    {
        ApiKey = "string",
        Period = "string",
        StartDate = "string",
        SymbolId = "string",
        EndDate = "string",
        Environment = "string",
        Limit = 0,
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});

example, err := airbyte.NewSourceCoinApi(ctx, "sourceCoinApiResource", &airbyte.SourceCoinApiArgs{
Configuration: &.SourceCoinApiConfigurationArgs{
ApiKey: pulumi.String("string"),
Period: pulumi.String("string"),
StartDate: pulumi.String("string"),
SymbolId: pulumi.String("string"),
EndDate: pulumi.String("string"),
Environment: pulumi.String("string"),
Limit: pulumi.Float64(0),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})

var sourceCoinApiResource = new SourceCoinApi("sourceCoinApiResource", SourceCoinApiArgs.builder()
    .configuration(SourceCoinApiConfigurationArgs.builder()
        .apiKey("string")
        .period("string")
        .startDate("string")
        .symbolId("string")
        .endDate("string")
        .environment("string")
        .limit(0)
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());

source_coin_api_resource = airbyte.SourceCoinApi("sourceCoinApiResource",
    configuration={
        "api_key": "string",
        "period": "string",
        "start_date": "string",
        "symbol_id": "string",
        "end_date": "string",
        "environment": "string",
        "limit": 0,
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")

const sourceCoinApiResource = new airbyte.SourceCoinApi("sourceCoinApiResource", {
    configuration: {
        apiKey: "string",
        period: "string",
        startDate: "string",
        symbolId: "string",
        endDate: "string",
        environment: "string",
        limit: 0,
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});

type: airbyte:SourceCoinApi
properties:
    configuration:
        apiKey: string
        endDate: string
        environment: string
        limit: 0
        period: string
        startDate: string
        symbolId: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string

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

Configuration SourceCoinApiConfiguration
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 SourceCoinApiConfigurationArgs
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 SourceCoinApiConfiguration
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 SourceCoinApiConfiguration
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 SourceCoinApiConfigurationArgs
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 SourceCoinApi 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 SourceCoinApi Resource

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

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

func GetSourceCoinApi(ctx *Context, name string, id IDInput, state *SourceCoinApiState, opts ...ResourceOption) (*SourceCoinApi, error)

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

public static SourceCoinApi get(String name, Output<String> id, SourceCoinApiState state, CustomResourceOptions options)

resources:  _:    type: airbyte:SourceCoinApi    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 SourceCoinApiConfiguration
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 SourceCoinApiConfigurationArgs
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 SourceCoinApiConfiguration
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 SourceCoinApiConfiguration
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 SourceCoinApiConfigurationArgs
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

SourceCoinApiConfiguration, SourceCoinApiConfigurationArgs

ApiKey string: API Key
Period string: The period to use. See the documentation for a list. https://docs.coinapi.io/#list-all-periods-get
StartDate string: The start date in ISO 8601 format.
SymbolId string: The symbol ID to use. See the documentation for a list. https://docs.coinapi.io/#list-all-symbols-get
EndDate string: The end date in ISO 8601 format. If not supplied, data will be returned from the start date to the current time, or when the count of result elements reaches its limit.
Environment string: The environment to use. Either sandbox or production. Default: "sandbox"; must be one of ["sandbox", "production"]
Limit double: The maximum number of elements to return. If not supplied, the default is 100. For numbers larger than 100, each 100 items is counted as one request for pricing purposes. Maximum value is 100000. Default: 100

ApiKey string: API Key
Period string: The period to use. See the documentation for a list. https://docs.coinapi.io/#list-all-periods-get
StartDate string: The start date in ISO 8601 format.
SymbolId string: The symbol ID to use. See the documentation for a list. https://docs.coinapi.io/#list-all-symbols-get
EndDate string: The end date in ISO 8601 format. If not supplied, data will be returned from the start date to the current time, or when the count of result elements reaches its limit.
Environment string: The environment to use. Either sandbox or production. Default: "sandbox"; must be one of ["sandbox", "production"]
Limit float64: The maximum number of elements to return. If not supplied, the default is 100. For numbers larger than 100, each 100 items is counted as one request for pricing purposes. Maximum value is 100000. Default: 100

apiKey String: API Key
period String: The period to use. See the documentation for a list. https://docs.coinapi.io/#list-all-periods-get
startDate String: The start date in ISO 8601 format.
symbolId String: The symbol ID to use. See the documentation for a list. https://docs.coinapi.io/#list-all-symbols-get
endDate String: The end date in ISO 8601 format. If not supplied, data will be returned from the start date to the current time, or when the count of result elements reaches its limit.
environment String: The environment to use. Either sandbox or production. Default: "sandbox"; must be one of ["sandbox", "production"]
limit Double: The maximum number of elements to return. If not supplied, the default is 100. For numbers larger than 100, each 100 items is counted as one request for pricing purposes. Maximum value is 100000. Default: 100

apiKey string: API Key
period string: The period to use. See the documentation for a list. https://docs.coinapi.io/#list-all-periods-get
startDate string: The start date in ISO 8601 format.
symbolId string: The symbol ID to use. See the documentation for a list. https://docs.coinapi.io/#list-all-symbols-get
endDate string: The end date in ISO 8601 format. If not supplied, data will be returned from the start date to the current time, or when the count of result elements reaches its limit.
environment string: The environment to use. Either sandbox or production. Default: "sandbox"; must be one of ["sandbox", "production"]
limit number: The maximum number of elements to return. If not supplied, the default is 100. For numbers larger than 100, each 100 items is counted as one request for pricing purposes. Maximum value is 100000. Default: 100

api_key str: API Key
period str: The period to use. See the documentation for a list. https://docs.coinapi.io/#list-all-periods-get
start_date str: The start date in ISO 8601 format.
symbol_id str: The symbol ID to use. See the documentation for a list. https://docs.coinapi.io/#list-all-symbols-get
end_date str: The end date in ISO 8601 format. If not supplied, data will be returned from the start date to the current time, or when the count of result elements reaches its limit.
environment str: The environment to use. Either sandbox or production. Default: "sandbox"; must be one of ["sandbox", "production"]
limit float: The maximum number of elements to return. If not supplied, the default is 100. For numbers larger than 100, each 100 items is counted as one request for pricing purposes. Maximum value is 100000. Default: 100

apiKey String: API Key
period String: The period to use. See the documentation for a list. https://docs.coinapi.io/#list-all-periods-get
startDate String: The start date in ISO 8601 format.
symbolId String: The symbol ID to use. See the documentation for a list. https://docs.coinapi.io/#list-all-symbols-get
endDate String: The end date in ISO 8601 format. If not supplied, data will be returned from the start date to the current time, or when the count of result elements reaches its limit.
environment String: The environment to use. Either sandbox or production. Default: "sandbox"; must be one of ["sandbox", "production"]
limit Number: The maximum number of elements to return. If not supplied, the default is 100. For numbers larger than 100, each 100 items is counted as one request for pricing purposes. Maximum value is 100000. Default: 100

Import

$ pulumi import airbyte:index/sourceCoinApi:SourceCoinApi my_airbyte_source_coin_api ""

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

On this page

On this page

Example Usage

Create SourceCoinApi Resource

Constructor syntax

Parameters

Constructor example

SourceCoinApi Resource Properties

Inputs

Outputs

Look up Existing SourceCoinApi Resource

Supporting Types

SourceCoinApiConfiguration, SourceCoinApiConfigurationArgs

Import

Package Details

On this page

On this page