airbyte 0.7.0-beta2, Mar 7 25

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

airbyte.SourceOpenaq

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.SourceOpenaq;
import com.pulumi.airbyte.SourceOpenaqArgs;
import com.pulumi.airbyte.inputs.SourceOpenaqConfigurationArgs;
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 mySourceOpenaq = new SourceOpenaq("mySourceOpenaq", SourceOpenaqArgs.builder()
            .configuration(SourceOpenaqConfigurationArgs.builder()
                .api_key("...my_api_key...")
                .country_ids("{ \"see\": \"documentation\" }")
                .build())
            .definitionId("4749a147-4bf6-47ca-9bb0-047b4e548536")
            .secretId("...my_secret_id...")
            .workspaceId("3edd5344-04d7-4e15-af1a-24d81b653a9a")
            .build());

    }
}

resources:
  mySourceOpenaq:
    type: airbyte:SourceOpenaq
    properties:
      configuration:
        api_key: '...my_api_key...'
        country_ids:
          - '{ "see": "documentation" }'
      definitionId: 4749a147-4bf6-47ca-9bb0-047b4e548536
      secretId: '...my_secret_id...'
      workspaceId: 3edd5344-04d7-4e15-af1a-24d81b653a9a

Create SourceOpenaq Resource

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

Constructor syntax

new SourceOpenaq(name: string, args: SourceOpenaqArgs, opts?: CustomResourceOptions);

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

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

func NewSourceOpenaq(ctx *Context, name string, args SourceOpenaqArgs, opts ...ResourceOption) (*SourceOpenaq, error)

public SourceOpenaq(string name, SourceOpenaqArgs args, CustomResourceOptions? opts = null)

public SourceOpenaq(String name, SourceOpenaqArgs args)
public SourceOpenaq(String name, SourceOpenaqArgs args, CustomResourceOptions options)

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

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

name String: The unique name of the resource.
args SourceOpenaqArgs: 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 sourceOpenaqResource = new Airbyte.SourceOpenaq("sourceOpenaqResource", new()
{
    Configuration = new Airbyte.Inputs.SourceOpenaqConfigurationArgs
    {
        ApiKey = "string",
        CountryIds = new[]
        {
            "string",
        },
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});

example, err := airbyte.NewSourceOpenaq(ctx, "sourceOpenaqResource", &airbyte.SourceOpenaqArgs{
Configuration: &.SourceOpenaqConfigurationArgs{
ApiKey: pulumi.String("string"),
CountryIds: pulumi.StringArray{
pulumi.String("string"),
},
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})

var sourceOpenaqResource = new SourceOpenaq("sourceOpenaqResource", SourceOpenaqArgs.builder()
    .configuration(SourceOpenaqConfigurationArgs.builder()
        .apiKey("string")
        .countryIds("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());

source_openaq_resource = airbyte.SourceOpenaq("sourceOpenaqResource",
    configuration={
        "api_key": "string",
        "country_ids": ["string"],
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")

const sourceOpenaqResource = new airbyte.SourceOpenaq("sourceOpenaqResource", {
    configuration: {
        apiKey: "string",
        countryIds: ["string"],
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});

type: airbyte:SourceOpenaq
properties:
    configuration:
        apiKey: string
        countryIds:
            - string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string

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

Configuration SourceOpenaqConfiguration
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 SourceOpenaqConfigurationArgs
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 SourceOpenaqConfiguration
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 SourceOpenaqConfiguration
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 SourceOpenaqConfigurationArgs
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 SourceOpenaq 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 SourceOpenaq Resource

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

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

func GetSourceOpenaq(ctx *Context, name string, id IDInput, state *SourceOpenaqState, opts ...ResourceOption) (*SourceOpenaq, error)

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

public static SourceOpenaq get(String name, Output<String> id, SourceOpenaqState state, CustomResourceOptions options)

resources:  _:    type: airbyte:SourceOpenaq    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 SourceOpenaqConfiguration
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 SourceOpenaqConfigurationArgs
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 SourceOpenaqConfiguration
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 SourceOpenaqConfiguration
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 SourceOpenaqConfigurationArgs
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

SourceOpenaqConfiguration, SourceOpenaqConfigurationArgs

ApiKey string
CountryIds List<string>: The list of IDs of countries (comma separated) you need the data for, check more: https://docs.openaq.org/resources/countries

ApiKey string
CountryIds []string: The list of IDs of countries (comma separated) you need the data for, check more: https://docs.openaq.org/resources/countries

apiKey String
countryIds List<String>: The list of IDs of countries (comma separated) you need the data for, check more: https://docs.openaq.org/resources/countries

apiKey string
countryIds string[]: The list of IDs of countries (comma separated) you need the data for, check more: https://docs.openaq.org/resources/countries

api_key str
country_ids Sequence[str]: The list of IDs of countries (comma separated) you need the data for, check more: https://docs.openaq.org/resources/countries

apiKey String
countryIds List<String>: The list of IDs of countries (comma separated) you need the data for, check more: https://docs.openaq.org/resources/countries

Import

$ pulumi import airbyte:index/sourceOpenaq:SourceOpenaq my_airbyte_source_openaq ""

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

On this page

On this page

Example Usage

Create SourceOpenaq Resource

Constructor syntax

Parameters

Constructor example

SourceOpenaq Resource Properties

Inputs

Outputs

Look up Existing SourceOpenaq Resource

Supporting Types

SourceOpenaqConfiguration, SourceOpenaqConfigurationArgs

Import

Package Details

On this page

On this page