Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Airbyte Provider
  3. API Docs
  4. SourcePlausible
airbyte 0.8.1-beta published on Saturday, Mar 29, 2025 by airbytehq
airbytehq/terraform-provider-airbyte

airbyte.SourcePlausible

Explore with Pulumi AI

airbyte 0.8.1-beta published on Saturday, Mar 29, 2025 by airbytehq
airbytehq/terraform-provider-airbyte

SourcePlausible 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.SourcePlausible;
import com.pulumi.airbyte.SourcePlausibleArgs;
import com.pulumi.airbyte.inputs.SourcePlausibleConfigurationArgs;
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 mySourcePlausible = new SourcePlausible("mySourcePlausible", SourcePlausibleArgs.builder()
            .configuration(SourcePlausibleConfigurationArgs.builder()
                .api_key("...my_api_key...")
                .api_url("https://plausible.example.com/api/v1/stats")
                .site_id("airbyte.com")
                .start_date("YYYY-MM-DD")
                .build())
            .definitionId("937af74f-fa25-43ac-a8a4-b4cb2a71cff5")
            .secretId("...my_secret_id...")
            .workspaceId("fc6bfb72-cbc1-4b9e-9a77-cf31c792e631")
            .build());

    }
}
Copy
resources:
  mySourcePlausible:
    type: airbyte:SourcePlausible
    properties:
      configuration:
        api_key: '...my_api_key...'
        api_url: https://plausible.example.com/api/v1/stats
        site_id: airbyte.com
        start_date: YYYY-MM-DD
      definitionId: 937af74f-fa25-43ac-a8a4-b4cb2a71cff5
      secretId: '...my_secret_id...'
      workspaceId: fc6bfb72-cbc1-4b9e-9a77-cf31c792e631
Copy

Create SourcePlausible Resource

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

Constructor syntax

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

@overload
def SourcePlausible(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    configuration: Optional[SourcePlausibleConfigurationArgs] = None,
                    workspace_id: Optional[str] = None,
                    definition_id: Optional[str] = None,
                    name: Optional[str] = None,
                    secret_id: Optional[str] = None)
func NewSourcePlausible(ctx *Context, name string, args SourcePlausibleArgs, opts ...ResourceOption) (*SourcePlausible, error)
public SourcePlausible(string name, SourcePlausibleArgs args, CustomResourceOptions? opts = null)
public SourcePlausible(String name, SourcePlausibleArgs args)
public SourcePlausible(String name, SourcePlausibleArgs args, CustomResourceOptions options)

type: airbyte:SourcePlausible
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. SourcePlausibleArgs
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. SourcePlausibleArgs
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. SourcePlausibleArgs
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. SourcePlausibleArgs
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. SourcePlausibleArgs
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 sourcePlausibleResource = new Airbyte.SourcePlausible("sourcePlausibleResource", new()
{
    Configuration = new Airbyte.Inputs.SourcePlausibleConfigurationArgs
    {
        ApiKey = "string",
        SiteId = "string",
        ApiUrl = "string",
        StartDate = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});
Copy
example, err := airbyte.NewSourcePlausible(ctx, "sourcePlausibleResource", &airbyte.SourcePlausibleArgs{
Configuration: &.SourcePlausibleConfigurationArgs{
ApiKey: pulumi.String("string"),
SiteId: pulumi.String("string"),
ApiUrl: pulumi.String("string"),
StartDate: pulumi.String("string"),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})
Copy
var sourcePlausibleResource = new SourcePlausible("sourcePlausibleResource", SourcePlausibleArgs.builder()
    .configuration(SourcePlausibleConfigurationArgs.builder()
        .apiKey("string")
        .siteId("string")
        .apiUrl("string")
        .startDate("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());
Copy
source_plausible_resource = airbyte.SourcePlausible("sourcePlausibleResource",
    configuration={
        "api_key": "string",
        "site_id": "string",
        "api_url": "string",
        "start_date": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")
Copy
const sourcePlausibleResource = new airbyte.SourcePlausible("sourcePlausibleResource", {
    configuration: {
        apiKey: "string",
        siteId: "string",
        apiUrl: "string",
        startDate: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});
Copy
type: airbyte:SourcePlausible
properties:
    configuration:
        apiKey: string
        apiUrl: string
        siteId: string
        startDate: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string
Copy

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

Configuration This property is required. SourcePlausibleConfiguration
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. SourcePlausibleConfigurationArgs
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. SourcePlausibleConfiguration
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. SourcePlausibleConfiguration
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. SourcePlausibleConfigurationArgs
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 SourcePlausible resource produces the following output properties:

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

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

SourcePlausibleConfiguration
, SourcePlausibleConfigurationArgs

ApiKey This property is required. string
Plausible API Key. See the \n\ndocs\n\n for information on how to generate this key.
SiteId This property is required. string
The domain of the site you want to retrieve data for. Enter the name of your site as configured on Plausible, i.e., excluding "https://" and "www". Can be retrieved from the 'domain' field in your Plausible site settings.
ApiUrl string
The API URL of your plausible instance. Change this if you self-host plausible. The default is https://plausible.io/api/v1/stats
StartDate string
Start date for data to retrieve, in ISO-8601 format.
ApiKey This property is required. string
Plausible API Key. See the \n\ndocs\n\n for information on how to generate this key.
SiteId This property is required. string
The domain of the site you want to retrieve data for. Enter the name of your site as configured on Plausible, i.e., excluding "https://" and "www". Can be retrieved from the 'domain' field in your Plausible site settings.
ApiUrl string
The API URL of your plausible instance. Change this if you self-host plausible. The default is https://plausible.io/api/v1/stats
StartDate string
Start date for data to retrieve, in ISO-8601 format.
apiKey This property is required. String
Plausible API Key. See the \n\ndocs\n\n for information on how to generate this key.
siteId This property is required. String
The domain of the site you want to retrieve data for. Enter the name of your site as configured on Plausible, i.e., excluding "https://" and "www". Can be retrieved from the 'domain' field in your Plausible site settings.
apiUrl String
The API URL of your plausible instance. Change this if you self-host plausible. The default is https://plausible.io/api/v1/stats
startDate String
Start date for data to retrieve, in ISO-8601 format.
apiKey This property is required. string
Plausible API Key. See the \n\ndocs\n\n for information on how to generate this key.
siteId This property is required. string
The domain of the site you want to retrieve data for. Enter the name of your site as configured on Plausible, i.e., excluding "https://" and "www". Can be retrieved from the 'domain' field in your Plausible site settings.
apiUrl string
The API URL of your plausible instance. Change this if you self-host plausible. The default is https://plausible.io/api/v1/stats
startDate string
Start date for data to retrieve, in ISO-8601 format.
api_key This property is required. str
Plausible API Key. See the \n\ndocs\n\n for information on how to generate this key.
site_id This property is required. str
The domain of the site you want to retrieve data for. Enter the name of your site as configured on Plausible, i.e., excluding "https://" and "www". Can be retrieved from the 'domain' field in your Plausible site settings.
api_url str
The API URL of your plausible instance. Change this if you self-host plausible. The default is https://plausible.io/api/v1/stats
start_date str
Start date for data to retrieve, in ISO-8601 format.
apiKey This property is required. String
Plausible API Key. See the \n\ndocs\n\n for information on how to generate this key.
siteId This property is required. String
The domain of the site you want to retrieve data for. Enter the name of your site as configured on Plausible, i.e., excluding "https://" and "www". Can be retrieved from the 'domain' field in your Plausible site settings.
apiUrl String
The API URL of your plausible instance. Change this if you self-host plausible. The default is https://plausible.io/api/v1/stats
startDate String
Start date for data to retrieve, in ISO-8601 format.

SourcePlausibleResourceAllocation
, SourcePlausibleResourceAllocationArgs

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

SourcePlausibleResourceAllocationDefault
, SourcePlausibleResourceAllocationDefaultArgs

SourcePlausibleResourceAllocationJobSpecific
, SourcePlausibleResourceAllocationJobSpecificArgs

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

SourcePlausibleResourceAllocationJobSpecificResourceRequirements
, SourcePlausibleResourceAllocationJobSpecificResourceRequirementsArgs

Import

$ pulumi import airbyte:index/sourcePlausible:SourcePlausible my_airbyte_source_plausible ""
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.
airbyte 0.8.1-beta published on Saturday, Mar 29, 2025 by airbytehq
airbytehq/terraform-provider-airbyte