airbyte 0.7.0-beta2, Mar 7 25

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

airbyte.SourceOrb

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.SourceOrb;
import com.pulumi.airbyte.SourceOrbArgs;
import com.pulumi.airbyte.inputs.SourceOrbConfigurationArgs;
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 mySourceOrb = new SourceOrb("mySourceOrb", SourceOrbArgs.builder()
            .configuration(SourceOrbConfigurationArgs.builder()
                .api_key("...my_api_key...")
                .end_date("2024-03-01T00:00:00Z")
                .lookback_window_days(9)
                .numeric_event_properties_keys("...")
                .plan_id("...my_plan_id...")
                .start_date("2022-03-01T00:00:00Z")
                .string_event_properties_keys("...")
                .subscription_usage_grouping_key("...my_subscription_usage_grouping_key...")
                .build())
            .definitionId("ee26274e-71bb-401d-a439-e0b1460278b2")
            .secretId("...my_secret_id...")
            .workspaceId("cd62c0b7-5370-44f8-929a-03ac1f7fe259")
            .build());

    }
}

resources:
  mySourceOrb:
    type: airbyte:SourceOrb
    properties:
      configuration:
        api_key: '...my_api_key...'
        end_date: 2024-03-01T00:00:00Z
        lookback_window_days: 9
        numeric_event_properties_keys:
          - '...'
        plan_id: '...my_plan_id...'
        start_date: 2022-03-01T00:00:00Z
        string_event_properties_keys:
          - '...'
        subscription_usage_grouping_key: '...my_subscription_usage_grouping_key...'
      definitionId: ee26274e-71bb-401d-a439-e0b1460278b2
      secretId: '...my_secret_id...'
      workspaceId: cd62c0b7-5370-44f8-929a-03ac1f7fe259

Create SourceOrb Resource

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

Constructor syntax

new SourceOrb(name: string, args: SourceOrbArgs, opts?: CustomResourceOptions);

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

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

func NewSourceOrb(ctx *Context, name string, args SourceOrbArgs, opts ...ResourceOption) (*SourceOrb, error)

public SourceOrb(string name, SourceOrbArgs args, CustomResourceOptions? opts = null)

public SourceOrb(String name, SourceOrbArgs args)
public SourceOrb(String name, SourceOrbArgs args, CustomResourceOptions options)

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

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

name String: The unique name of the resource.
args SourceOrbArgs: 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 sourceOrbResource = new Airbyte.SourceOrb("sourceOrbResource", new()
{
    Configuration = new Airbyte.Inputs.SourceOrbConfigurationArgs
    {
        ApiKey = "string",
        StartDate = "string",
        EndDate = "string",
        LookbackWindowDays = 0,
        NumericEventPropertiesKeys = new[]
        {
            "string",
        },
        PlanId = "string",
        StringEventPropertiesKeys = new[]
        {
            "string",
        },
        SubscriptionUsageGroupingKey = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});

example, err := airbyte.NewSourceOrb(ctx, "sourceOrbResource", &airbyte.SourceOrbArgs{
Configuration: &.SourceOrbConfigurationArgs{
ApiKey: pulumi.String("string"),
StartDate: pulumi.String("string"),
EndDate: pulumi.String("string"),
LookbackWindowDays: pulumi.Float64(0),
NumericEventPropertiesKeys: pulumi.StringArray{
pulumi.String("string"),
},
PlanId: pulumi.String("string"),
StringEventPropertiesKeys: pulumi.StringArray{
pulumi.String("string"),
},
SubscriptionUsageGroupingKey: pulumi.String("string"),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})

var sourceOrbResource = new SourceOrb("sourceOrbResource", SourceOrbArgs.builder()
    .configuration(SourceOrbConfigurationArgs.builder()
        .apiKey("string")
        .startDate("string")
        .endDate("string")
        .lookbackWindowDays(0)
        .numericEventPropertiesKeys("string")
        .planId("string")
        .stringEventPropertiesKeys("string")
        .subscriptionUsageGroupingKey("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());

source_orb_resource = airbyte.SourceOrb("sourceOrbResource",
    configuration={
        "api_key": "string",
        "start_date": "string",
        "end_date": "string",
        "lookback_window_days": 0,
        "numeric_event_properties_keys": ["string"],
        "plan_id": "string",
        "string_event_properties_keys": ["string"],
        "subscription_usage_grouping_key": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")

const sourceOrbResource = new airbyte.SourceOrb("sourceOrbResource", {
    configuration: {
        apiKey: "string",
        startDate: "string",
        endDate: "string",
        lookbackWindowDays: 0,
        numericEventPropertiesKeys: ["string"],
        planId: "string",
        stringEventPropertiesKeys: ["string"],
        subscriptionUsageGroupingKey: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});

type: airbyte:SourceOrb
properties:
    configuration:
        apiKey: string
        endDate: string
        lookbackWindowDays: 0
        numericEventPropertiesKeys:
            - string
        planId: string
        startDate: string
        stringEventPropertiesKeys:
            - string
        subscriptionUsageGroupingKey: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string

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

Configuration SourceOrbConfiguration
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 SourceOrbConfigurationArgs
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 SourceOrbConfiguration
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 SourceOrbConfiguration
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 SourceOrbConfigurationArgs
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 SourceOrb 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 SourceOrb Resource

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

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

func GetSourceOrb(ctx *Context, name string, id IDInput, state *SourceOrbState, opts ...ResourceOption) (*SourceOrb, error)

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

public static SourceOrb get(String name, Output<String> id, SourceOrbState state, CustomResourceOptions options)

resources:  _:    type: airbyte:SourceOrb    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 SourceOrbConfiguration
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 SourceOrbConfigurationArgs
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 SourceOrbConfiguration
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 SourceOrbConfiguration
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 SourceOrbConfigurationArgs
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

SourceOrbConfiguration, SourceOrbConfigurationArgs

ApiKey string: Orb API Key, issued from the Orb admin console.
StartDate string: UTC date and time in the format 2022-03-01T00:00:00Z. Any data with created_at before this data will not be synced. For Subscription Usage, this becomes the timeframe_start API parameter.
EndDate string: UTC date and time in the format 2022-03-01T00:00:00Z. Any data with created_at after this data will not be synced. For Subscription Usage, this becomes the timeframe_start API parameter.
LookbackWindowDays double: When set to N, the connector will always refresh resources created within the past N days. By default, updated objects that are not newly created are not incrementally synced. Default: 0
NumericEventPropertiesKeys List<string>: Property key names to extract from all events, in order to enrich ledger entries corresponding to an event deduction.
PlanId string: Orb Plan ID to filter subscriptions that should have usage fetched.
StringEventPropertiesKeys List<string>: Property key names to extract from all events, in order to enrich ledger entries corresponding to an event deduction.
SubscriptionUsageGroupingKey string: Property key name to group subscription usage by.

ApiKey string: Orb API Key, issued from the Orb admin console.
StartDate string: UTC date and time in the format 2022-03-01T00:00:00Z. Any data with created_at before this data will not be synced. For Subscription Usage, this becomes the timeframe_start API parameter.
EndDate string: UTC date and time in the format 2022-03-01T00:00:00Z. Any data with created_at after this data will not be synced. For Subscription Usage, this becomes the timeframe_start API parameter.
LookbackWindowDays float64: When set to N, the connector will always refresh resources created within the past N days. By default, updated objects that are not newly created are not incrementally synced. Default: 0
NumericEventPropertiesKeys []string: Property key names to extract from all events, in order to enrich ledger entries corresponding to an event deduction.
PlanId string: Orb Plan ID to filter subscriptions that should have usage fetched.
StringEventPropertiesKeys []string: Property key names to extract from all events, in order to enrich ledger entries corresponding to an event deduction.
SubscriptionUsageGroupingKey string: Property key name to group subscription usage by.

apiKey String: Orb API Key, issued from the Orb admin console.
startDate String: UTC date and time in the format 2022-03-01T00:00:00Z. Any data with created_at before this data will not be synced. For Subscription Usage, this becomes the timeframe_start API parameter.
endDate String: UTC date and time in the format 2022-03-01T00:00:00Z. Any data with created_at after this data will not be synced. For Subscription Usage, this becomes the timeframe_start API parameter.
lookbackWindowDays Double: When set to N, the connector will always refresh resources created within the past N days. By default, updated objects that are not newly created are not incrementally synced. Default: 0
numericEventPropertiesKeys List<String>: Property key names to extract from all events, in order to enrich ledger entries corresponding to an event deduction.
planId String: Orb Plan ID to filter subscriptions that should have usage fetched.
stringEventPropertiesKeys List<String>: Property key names to extract from all events, in order to enrich ledger entries corresponding to an event deduction.
subscriptionUsageGroupingKey String: Property key name to group subscription usage by.

apiKey string: Orb API Key, issued from the Orb admin console.
startDate string: UTC date and time in the format 2022-03-01T00:00:00Z. Any data with created_at before this data will not be synced. For Subscription Usage, this becomes the timeframe_start API parameter.
endDate string: UTC date and time in the format 2022-03-01T00:00:00Z. Any data with created_at after this data will not be synced. For Subscription Usage, this becomes the timeframe_start API parameter.
lookbackWindowDays number: When set to N, the connector will always refresh resources created within the past N days. By default, updated objects that are not newly created are not incrementally synced. Default: 0
numericEventPropertiesKeys string[]: Property key names to extract from all events, in order to enrich ledger entries corresponding to an event deduction.
planId string: Orb Plan ID to filter subscriptions that should have usage fetched.
stringEventPropertiesKeys string[]: Property key names to extract from all events, in order to enrich ledger entries corresponding to an event deduction.
subscriptionUsageGroupingKey string: Property key name to group subscription usage by.

api_key str: Orb API Key, issued from the Orb admin console.
start_date str: UTC date and time in the format 2022-03-01T00:00:00Z. Any data with created_at before this data will not be synced. For Subscription Usage, this becomes the timeframe_start API parameter.
end_date str: UTC date and time in the format 2022-03-01T00:00:00Z. Any data with created_at after this data will not be synced. For Subscription Usage, this becomes the timeframe_start API parameter.
lookback_window_days float: When set to N, the connector will always refresh resources created within the past N days. By default, updated objects that are not newly created are not incrementally synced. Default: 0
numeric_event_properties_keys Sequence[str]: Property key names to extract from all events, in order to enrich ledger entries corresponding to an event deduction.
plan_id str: Orb Plan ID to filter subscriptions that should have usage fetched.
string_event_properties_keys Sequence[str]: Property key names to extract from all events, in order to enrich ledger entries corresponding to an event deduction.
subscription_usage_grouping_key str: Property key name to group subscription usage by.

apiKey String: Orb API Key, issued from the Orb admin console.
startDate String: UTC date and time in the format 2022-03-01T00:00:00Z. Any data with created_at before this data will not be synced. For Subscription Usage, this becomes the timeframe_start API parameter.
endDate String: UTC date and time in the format 2022-03-01T00:00:00Z. Any data with created_at after this data will not be synced. For Subscription Usage, this becomes the timeframe_start API parameter.
lookbackWindowDays Number: When set to N, the connector will always refresh resources created within the past N days. By default, updated objects that are not newly created are not incrementally synced. Default: 0
numericEventPropertiesKeys List<String>: Property key names to extract from all events, in order to enrich ledger entries corresponding to an event deduction.
planId String: Orb Plan ID to filter subscriptions that should have usage fetched.
stringEventPropertiesKeys List<String>: Property key names to extract from all events, in order to enrich ledger entries corresponding to an event deduction.
subscriptionUsageGroupingKey String: Property key name to group subscription usage by.

Import

$ pulumi import airbyte:index/sourceOrb:SourceOrb my_airbyte_source_orb ""

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

On this page

On this page

Example Usage

Create SourceOrb Resource

Constructor syntax

Parameters

Constructor example

SourceOrb Resource Properties

Inputs

Outputs

Look up Existing SourceOrb Resource

Supporting Types

SourceOrbConfiguration, SourceOrbConfigurationArgs

Import

Package Details

On this page

On this page