1. Packages
  2. Airbyte Provider
  3. API Docs
  4. SourceReddit
airbyte 0.9.0 published on Wednesday, Apr 9, 2025 by airbytehq

airbyte.SourceReddit

Explore with Pulumi AI

SourceReddit 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.SourceReddit;
import com.pulumi.airbyte.SourceRedditArgs;
import com.pulumi.airbyte.inputs.SourceRedditConfigurationArgs;
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 mySourceReddit = new SourceReddit("mySourceReddit", SourceRedditArgs.builder()
            .configuration(SourceRedditConfigurationArgs.builder()
                .api_key("...my_api_key...")
                .exact(false)
                .include_over_18(false)
                .limit(7.22)
                .query("...my_query...")
                .start_date("2022-03-13T00:28:12.795Z")
                .subreddits("{ \"see\": \"documentation\" }")
                .build())
            .definitionId("4f067f59-71b2-4ee8-9f10-699b0aa1c7e5")
            .secretId("...my_secret_id...")
            .workspaceId("aa39cb1c-7b7a-4dd0-8715-54f9fb9a7b25")
            .build());

    }
}
Copy
resources:
  mySourceReddit:
    type: airbyte:SourceReddit
    properties:
      configuration:
        api_key: '...my_api_key...'
        exact: false
        include_over_18: false
        limit: 7.22
        query: '...my_query...'
        start_date: 2022-03-13T00:28:12.795Z
        subreddits:
          - '{ "see": "documentation" }'
      definitionId: 4f067f59-71b2-4ee8-9f10-699b0aa1c7e5
      secretId: '...my_secret_id...'
      workspaceId: aa39cb1c-7b7a-4dd0-8715-54f9fb9a7b25
Copy

Create SourceReddit Resource

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

Constructor syntax

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

@overload
def SourceReddit(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 configuration: Optional[SourceRedditConfigurationArgs] = None,
                 workspace_id: Optional[str] = None,
                 definition_id: Optional[str] = None,
                 name: Optional[str] = None,
                 secret_id: Optional[str] = None)
func NewSourceReddit(ctx *Context, name string, args SourceRedditArgs, opts ...ResourceOption) (*SourceReddit, error)
public SourceReddit(string name, SourceRedditArgs args, CustomResourceOptions? opts = null)
public SourceReddit(String name, SourceRedditArgs args)
public SourceReddit(String name, SourceRedditArgs args, CustomResourceOptions options)
type: airbyte:SourceReddit
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. SourceRedditArgs
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. SourceRedditArgs
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. SourceRedditArgs
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. SourceRedditArgs
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. SourceRedditArgs
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 sourceRedditResource = new Airbyte.SourceReddit("sourceRedditResource", new()
{
    Configuration = new Airbyte.Inputs.SourceRedditConfigurationArgs
    {
        ApiKey = "string",
        StartDate = "string",
        Exact = false,
        IncludeOver18 = false,
        Limit = 0,
        Query = "string",
        Subreddits = new[]
        {
            "string",
        },
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});
Copy
example, err := airbyte.NewSourceReddit(ctx, "sourceRedditResource", &airbyte.SourceRedditArgs{
Configuration: &.SourceRedditConfigurationArgs{
ApiKey: pulumi.String("string"),
StartDate: pulumi.String("string"),
Exact: pulumi.Bool(false),
IncludeOver18: pulumi.Bool(false),
Limit: pulumi.Float64(0),
Query: pulumi.String("string"),
Subreddits: pulumi.StringArray{
pulumi.String("string"),
},
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})
Copy
var sourceRedditResource = new SourceReddit("sourceRedditResource", SourceRedditArgs.builder()
    .configuration(SourceRedditConfigurationArgs.builder()
        .apiKey("string")
        .startDate("string")
        .exact(false)
        .includeOver18(false)
        .limit(0)
        .query("string")
        .subreddits("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());
Copy
source_reddit_resource = airbyte.SourceReddit("sourceRedditResource",
    configuration={
        "api_key": "string",
        "start_date": "string",
        "exact": False,
        "include_over18": False,
        "limit": 0,
        "query": "string",
        "subreddits": ["string"],
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")
Copy
const sourceRedditResource = new airbyte.SourceReddit("sourceRedditResource", {
    configuration: {
        apiKey: "string",
        startDate: "string",
        exact: false,
        includeOver18: false,
        limit: 0,
        query: "string",
        subreddits: ["string"],
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});
Copy
type: airbyte:SourceReddit
properties:
    configuration:
        apiKey: string
        exact: false
        includeOver18: false
        limit: 0
        query: string
        startDate: string
        subreddits:
            - string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string
Copy

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

Configuration This property is required. SourceRedditConfiguration
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. SourceRedditConfigurationArgs
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. SourceRedditConfiguration
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. SourceRedditConfiguration
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. SourceRedditConfigurationArgs
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 SourceReddit resource produces the following output properties:

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

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

SourceRedditConfiguration
, SourceRedditConfigurationArgs

ApiKey This property is required. string
StartDate This property is required. string
Exact bool
Specifies exact keyword and reduces distractions
IncludeOver18 bool
Includes mature content. Default: false
Limit double
Max records per page limit
Query string
Specifies the query for searching in reddits and subreddits. Default: "airbyte"
Subreddits List<string>
Subreddits for exploration
ApiKey This property is required. string
StartDate This property is required. string
Exact bool
Specifies exact keyword and reduces distractions
IncludeOver18 bool
Includes mature content. Default: false
Limit float64
Max records per page limit
Query string
Specifies the query for searching in reddits and subreddits. Default: "airbyte"
Subreddits []string
Subreddits for exploration
apiKey This property is required. String
startDate This property is required. String
exact Boolean
Specifies exact keyword and reduces distractions
includeOver18 Boolean
Includes mature content. Default: false
limit Double
Max records per page limit
query String
Specifies the query for searching in reddits and subreddits. Default: "airbyte"
subreddits List<String>
Subreddits for exploration
apiKey This property is required. string
startDate This property is required. string
exact boolean
Specifies exact keyword and reduces distractions
includeOver18 boolean
Includes mature content. Default: false
limit number
Max records per page limit
query string
Specifies the query for searching in reddits and subreddits. Default: "airbyte"
subreddits string[]
Subreddits for exploration
api_key This property is required. str
start_date This property is required. str
exact bool
Specifies exact keyword and reduces distractions
include_over18 bool
Includes mature content. Default: false
limit float
Max records per page limit
query str
Specifies the query for searching in reddits and subreddits. Default: "airbyte"
subreddits Sequence[str]
Subreddits for exploration
apiKey This property is required. String
startDate This property is required. String
exact Boolean
Specifies exact keyword and reduces distractions
includeOver18 Boolean
Includes mature content. Default: false
limit Number
Max records per page limit
query String
Specifies the query for searching in reddits and subreddits. Default: "airbyte"
subreddits List<String>
Subreddits for exploration

SourceRedditResourceAllocation
, SourceRedditResourceAllocationArgs

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

SourceRedditResourceAllocationDefault
, SourceRedditResourceAllocationDefaultArgs

SourceRedditResourceAllocationJobSpecific
, SourceRedditResourceAllocationJobSpecificArgs

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

SourceRedditResourceAllocationJobSpecificResourceRequirements
, SourceRedditResourceAllocationJobSpecificResourceRequirementsArgs

Import

$ pulumi import airbyte:index/sourceReddit:SourceReddit my_airbyte_source_reddit ""
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.