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

airbyte.SourceFaker

Explore with Pulumi AI

SourceFaker 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.SourceFaker;
import com.pulumi.airbyte.SourceFakerArgs;
import com.pulumi.airbyte.inputs.SourceFakerConfigurationArgs;
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 mySourceFaker = new SourceFaker("mySourceFaker", SourceFakerArgs.builder()
            .configuration(SourceFakerConfigurationArgs.builder()
                .always_updated(true)
                .count(1)
                .parallelism(8)
                .records_per_slice(9)
                .seed(8)
                .build())
            .definitionId("7fa43101-44ad-4dbe-a821-bd8c667b2073")
            .secretId("...my_secret_id...")
            .workspaceId("ee51eafe-11ff-4a9a-99c4-b72ee665ba32")
            .build());

    }
}
Copy
resources:
  mySourceFaker:
    type: airbyte:SourceFaker
    properties:
      configuration:
        always_updated: true
        count: 1
        parallelism: 8
        records_per_slice: 9
        seed: 8
      definitionId: 7fa43101-44ad-4dbe-a821-bd8c667b2073
      secretId: '...my_secret_id...'
      workspaceId: ee51eafe-11ff-4a9a-99c4-b72ee665ba32
Copy

Create SourceFaker Resource

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

Constructor syntax

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

@overload
def SourceFaker(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                configuration: Optional[SourceFakerConfigurationArgs] = None,
                workspace_id: Optional[str] = None,
                definition_id: Optional[str] = None,
                name: Optional[str] = None,
                secret_id: Optional[str] = None)
func NewSourceFaker(ctx *Context, name string, args SourceFakerArgs, opts ...ResourceOption) (*SourceFaker, error)
public SourceFaker(string name, SourceFakerArgs args, CustomResourceOptions? opts = null)
public SourceFaker(String name, SourceFakerArgs args)
public SourceFaker(String name, SourceFakerArgs args, CustomResourceOptions options)
type: airbyte:SourceFaker
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. SourceFakerArgs
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. SourceFakerArgs
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. SourceFakerArgs
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. SourceFakerArgs
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. SourceFakerArgs
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 sourceFakerResource = new Airbyte.SourceFaker("sourceFakerResource", new()
{
    Configuration = new Airbyte.Inputs.SourceFakerConfigurationArgs
    {
        AlwaysUpdated = false,
        Count = 0,
        Parallelism = 0,
        RecordsPerSlice = 0,
        Seed = 0,
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});
Copy
example, err := airbyte.NewSourceFaker(ctx, "sourceFakerResource", &airbyte.SourceFakerArgs{
Configuration: &.SourceFakerConfigurationArgs{
AlwaysUpdated: pulumi.Bool(false),
Count: pulumi.Float64(0),
Parallelism: pulumi.Float64(0),
RecordsPerSlice: pulumi.Float64(0),
Seed: pulumi.Float64(0),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})
Copy
var sourceFakerResource = new SourceFaker("sourceFakerResource", SourceFakerArgs.builder()
    .configuration(SourceFakerConfigurationArgs.builder()
        .alwaysUpdated(false)
        .count(0)
        .parallelism(0)
        .recordsPerSlice(0)
        .seed(0)
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());
Copy
source_faker_resource = airbyte.SourceFaker("sourceFakerResource",
    configuration={
        "always_updated": False,
        "count": 0,
        "parallelism": 0,
        "records_per_slice": 0,
        "seed": 0,
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")
Copy
const sourceFakerResource = new airbyte.SourceFaker("sourceFakerResource", {
    configuration: {
        alwaysUpdated: false,
        count: 0,
        parallelism: 0,
        recordsPerSlice: 0,
        seed: 0,
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});
Copy
type: airbyte:SourceFaker
properties:
    configuration:
        alwaysUpdated: false
        count: 0
        parallelism: 0
        recordsPerSlice: 0
        seed: 0
    definitionId: string
    name: string
    secretId: string
    workspaceId: string
Copy

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

Configuration This property is required. SourceFakerConfiguration
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. SourceFakerConfigurationArgs
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. SourceFakerConfiguration
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. SourceFakerConfiguration
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. SourceFakerConfigurationArgs
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 SourceFaker resource produces the following output properties:

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

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

SourceFakerConfiguration
, SourceFakerConfigurationArgs

AlwaysUpdated bool
Should the updated_at values for every record be new each sync? Setting this to false will case the source to stop emitting records after COUNT records have been emitted. Default: true
Count double
How many users should be generated in total. The purchases table will be scaled to match, with 10 purchases created per 10 users. This setting does not apply to the products stream. Default: 1000
Parallelism double
How many parallel workers should we use to generate fake data? Choose a value equal to the number of CPUs you will allocate to this source. Default: 4
RecordsPerSlice double
How many fake records will be in each page (stream slice), before a state message is emitted?. Default: 1000
Seed double
Manually control the faker random seed to return the same values on subsequent runs (leave -1 for random). Default: -1
AlwaysUpdated bool
Should the updated_at values for every record be new each sync? Setting this to false will case the source to stop emitting records after COUNT records have been emitted. Default: true
Count float64
How many users should be generated in total. The purchases table will be scaled to match, with 10 purchases created per 10 users. This setting does not apply to the products stream. Default: 1000
Parallelism float64
How many parallel workers should we use to generate fake data? Choose a value equal to the number of CPUs you will allocate to this source. Default: 4
RecordsPerSlice float64
How many fake records will be in each page (stream slice), before a state message is emitted?. Default: 1000
Seed float64
Manually control the faker random seed to return the same values on subsequent runs (leave -1 for random). Default: -1
alwaysUpdated Boolean
Should the updated_at values for every record be new each sync? Setting this to false will case the source to stop emitting records after COUNT records have been emitted. Default: true
count Double
How many users should be generated in total. The purchases table will be scaled to match, with 10 purchases created per 10 users. This setting does not apply to the products stream. Default: 1000
parallelism Double
How many parallel workers should we use to generate fake data? Choose a value equal to the number of CPUs you will allocate to this source. Default: 4
recordsPerSlice Double
How many fake records will be in each page (stream slice), before a state message is emitted?. Default: 1000
seed Double
Manually control the faker random seed to return the same values on subsequent runs (leave -1 for random). Default: -1
alwaysUpdated boolean
Should the updated_at values for every record be new each sync? Setting this to false will case the source to stop emitting records after COUNT records have been emitted. Default: true
count number
How many users should be generated in total. The purchases table will be scaled to match, with 10 purchases created per 10 users. This setting does not apply to the products stream. Default: 1000
parallelism number
How many parallel workers should we use to generate fake data? Choose a value equal to the number of CPUs you will allocate to this source. Default: 4
recordsPerSlice number
How many fake records will be in each page (stream slice), before a state message is emitted?. Default: 1000
seed number
Manually control the faker random seed to return the same values on subsequent runs (leave -1 for random). Default: -1
always_updated bool
Should the updated_at values for every record be new each sync? Setting this to false will case the source to stop emitting records after COUNT records have been emitted. Default: true
count float
How many users should be generated in total. The purchases table will be scaled to match, with 10 purchases created per 10 users. This setting does not apply to the products stream. Default: 1000
parallelism float
How many parallel workers should we use to generate fake data? Choose a value equal to the number of CPUs you will allocate to this source. Default: 4
records_per_slice float
How many fake records will be in each page (stream slice), before a state message is emitted?. Default: 1000
seed float
Manually control the faker random seed to return the same values on subsequent runs (leave -1 for random). Default: -1
alwaysUpdated Boolean
Should the updated_at values for every record be new each sync? Setting this to false will case the source to stop emitting records after COUNT records have been emitted. Default: true
count Number
How many users should be generated in total. The purchases table will be scaled to match, with 10 purchases created per 10 users. This setting does not apply to the products stream. Default: 1000
parallelism Number
How many parallel workers should we use to generate fake data? Choose a value equal to the number of CPUs you will allocate to this source. Default: 4
recordsPerSlice Number
How many fake records will be in each page (stream slice), before a state message is emitted?. Default: 1000
seed Number
Manually control the faker random seed to return the same values on subsequent runs (leave -1 for random). Default: -1

SourceFakerResourceAllocation
, SourceFakerResourceAllocationArgs

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

SourceFakerResourceAllocationDefault
, SourceFakerResourceAllocationDefaultArgs

SourceFakerResourceAllocationJobSpecific
, SourceFakerResourceAllocationJobSpecificArgs

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

SourceFakerResourceAllocationJobSpecificResourceRequirements
, SourceFakerResourceAllocationJobSpecificResourceRequirementsArgs

Import

$ pulumi import airbyte:index/sourceFaker:SourceFaker my_airbyte_source_faker ""
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.