1. Packages
  2. Airbyte Provider
  3. API Docs
  4. SourceMetabase
airbyte 0.10.0 published on Monday, Apr 14, 2025 by airbytehq

airbyte.SourceMetabase

Explore with Pulumi AI

SourceMetabase 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.SourceMetabase;
import com.pulumi.airbyte.SourceMetabaseArgs;
import com.pulumi.airbyte.inputs.SourceMetabaseConfigurationArgs;
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 mySourceMetabase = new SourceMetabase("mySourceMetabase", SourceMetabaseArgs.builder()
            .configuration(SourceMetabaseConfigurationArgs.builder()
                .instance_api_url("https://localhost:3000/api/")
                .password("...my_password...")
                .session_token("...my_session_token...")
                .username("...my_username...")
                .build())
            .definitionId("d43c9538-9f19-48fa-839b-519d7ddc6528")
            .secretId("...my_secret_id...")
            .workspaceId("2a6ca9f4-7b13-4377-aec7-a4e44e8ebd23")
            .build());

    }
}
Copy
resources:
  mySourceMetabase:
    type: airbyte:SourceMetabase
    properties:
      configuration:
        instance_api_url: https://localhost:3000/api/
        password: '...my_password...'
        session_token: '...my_session_token...'
        username: '...my_username...'
      definitionId: d43c9538-9f19-48fa-839b-519d7ddc6528
      secretId: '...my_secret_id...'
      workspaceId: 2a6ca9f4-7b13-4377-aec7-a4e44e8ebd23
Copy

Create SourceMetabase Resource

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

Constructor syntax

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

@overload
def SourceMetabase(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   configuration: Optional[SourceMetabaseConfigurationArgs] = None,
                   workspace_id: Optional[str] = None,
                   definition_id: Optional[str] = None,
                   name: Optional[str] = None,
                   secret_id: Optional[str] = None)
func NewSourceMetabase(ctx *Context, name string, args SourceMetabaseArgs, opts ...ResourceOption) (*SourceMetabase, error)
public SourceMetabase(string name, SourceMetabaseArgs args, CustomResourceOptions? opts = null)
public SourceMetabase(String name, SourceMetabaseArgs args)
public SourceMetabase(String name, SourceMetabaseArgs args, CustomResourceOptions options)
type: airbyte:SourceMetabase
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. SourceMetabaseArgs
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. SourceMetabaseArgs
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. SourceMetabaseArgs
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. SourceMetabaseArgs
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. SourceMetabaseArgs
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 sourceMetabaseResource = new Airbyte.SourceMetabase("sourceMetabaseResource", new()
{
    Configuration = new Airbyte.Inputs.SourceMetabaseConfigurationArgs
    {
        InstanceApiUrl = "string",
        Username = "string",
        Password = "string",
        SessionToken = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});
Copy
example, err := airbyte.NewSourceMetabase(ctx, "sourceMetabaseResource", &airbyte.SourceMetabaseArgs{
Configuration: &.SourceMetabaseConfigurationArgs{
InstanceApiUrl: pulumi.String("string"),
Username: pulumi.String("string"),
Password: pulumi.String("string"),
SessionToken: pulumi.String("string"),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})
Copy
var sourceMetabaseResource = new SourceMetabase("sourceMetabaseResource", SourceMetabaseArgs.builder()
    .configuration(SourceMetabaseConfigurationArgs.builder()
        .instanceApiUrl("string")
        .username("string")
        .password("string")
        .sessionToken("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());
Copy
source_metabase_resource = airbyte.SourceMetabase("sourceMetabaseResource",
    configuration={
        "instance_api_url": "string",
        "username": "string",
        "password": "string",
        "session_token": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")
Copy
const sourceMetabaseResource = new airbyte.SourceMetabase("sourceMetabaseResource", {
    configuration: {
        instanceApiUrl: "string",
        username: "string",
        password: "string",
        sessionToken: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});
Copy
type: airbyte:SourceMetabase
properties:
    configuration:
        instanceApiUrl: string
        password: string
        sessionToken: string
        username: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string
Copy

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

Configuration This property is required. SourceMetabaseConfiguration
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. SourceMetabaseConfigurationArgs
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. SourceMetabaseConfiguration
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. SourceMetabaseConfiguration
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. SourceMetabaseConfigurationArgs
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 SourceMetabase resource produces the following output properties:

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

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

SourceMetabaseConfiguration
, SourceMetabaseConfigurationArgs

InstanceApiUrl This property is required. string
URL to your metabase instance API
Username This property is required. string
Password string
SessionToken string
To generate your session token, you need to run the following command: curl -X POST \ -H "Content-Type: application/json" \ -d '{"username": "person@metabase.com", "password": "fakepassword"}' \ http://localhost:3000/api/session Then copy the value of the id field returned by a successful call to that API. Note that by default, sessions are good for 14 days and needs to be regenerated.
InstanceApiUrl This property is required. string
URL to your metabase instance API
Username This property is required. string
Password string
SessionToken string
To generate your session token, you need to run the following command: curl -X POST \ -H "Content-Type: application/json" \ -d '{"username": "person@metabase.com", "password": "fakepassword"}' \ http://localhost:3000/api/session Then copy the value of the id field returned by a successful call to that API. Note that by default, sessions are good for 14 days and needs to be regenerated.
instanceApiUrl This property is required. String
URL to your metabase instance API
username This property is required. String
password String
sessionToken String
To generate your session token, you need to run the following command: curl -X POST \ -H "Content-Type: application/json" \ -d '{"username": "person@metabase.com", "password": "fakepassword"}' \ http://localhost:3000/api/session Then copy the value of the id field returned by a successful call to that API. Note that by default, sessions are good for 14 days and needs to be regenerated.
instanceApiUrl This property is required. string
URL to your metabase instance API
username This property is required. string
password string
sessionToken string
To generate your session token, you need to run the following command: curl -X POST \ -H "Content-Type: application/json" \ -d '{"username": "person@metabase.com", "password": "fakepassword"}' \ http://localhost:3000/api/session Then copy the value of the id field returned by a successful call to that API. Note that by default, sessions are good for 14 days and needs to be regenerated.
instance_api_url This property is required. str
URL to your metabase instance API
username This property is required. str
password str
session_token str
To generate your session token, you need to run the following command: curl -X POST \ -H "Content-Type: application/json" \ -d '{"username": "person@metabase.com", "password": "fakepassword"}' \ http://localhost:3000/api/session Then copy the value of the id field returned by a successful call to that API. Note that by default, sessions are good for 14 days and needs to be regenerated.
instanceApiUrl This property is required. String
URL to your metabase instance API
username This property is required. String
password String
sessionToken String
To generate your session token, you need to run the following command: curl -X POST \ -H "Content-Type: application/json" \ -d '{"username": "person@metabase.com", "password": "fakepassword"}' \ http://localhost:3000/api/session Then copy the value of the id field returned by a successful call to that API. Note that by default, sessions are good for 14 days and needs to be regenerated.

SourceMetabaseResourceAllocation
, SourceMetabaseResourceAllocationArgs

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

SourceMetabaseResourceAllocationDefault
, SourceMetabaseResourceAllocationDefaultArgs

SourceMetabaseResourceAllocationJobSpecific
, SourceMetabaseResourceAllocationJobSpecificArgs

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

SourceMetabaseResourceAllocationJobSpecificResourceRequirements
, SourceMetabaseResourceAllocationJobSpecificResourceRequirementsArgs

Import

$ pulumi import airbyte:index/sourceMetabase:SourceMetabase my_airbyte_source_metabase ""
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.