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

airbyte.SourceWatchmode

Explore with Pulumi AI

airbyte logo
airbyte 0.10.0 published on Monday, Apr 14, 2025 by airbytehq

    SourceWatchmode 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.SourceWatchmode;
    import com.pulumi.airbyte.SourceWatchmodeArgs;
    import com.pulumi.airbyte.inputs.SourceWatchmodeConfigurationArgs;
    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 mySourceWatchmode = new SourceWatchmode("mySourceWatchmode", SourceWatchmodeArgs.builder()
                .configuration(SourceWatchmodeConfigurationArgs.builder()
                    .api_key("...my_api_key...")
                    .search_val("...my_search_val...")
                    .start_date("2022-06-29T19:10:03.615Z")
                    .build())
                .definitionId("a0031fcd-269e-477f-923e-df7b78fdccfb")
                .secretId("...my_secret_id...")
                .workspaceId("d4150f21-ccba-4594-a601-68b3357ba468")
                .build());
    
        }
    }
    
    resources:
      mySourceWatchmode:
        type: airbyte:SourceWatchmode
        properties:
          configuration:
            api_key: '...my_api_key...'
            search_val: '...my_search_val...'
            start_date: 2022-06-29T19:10:03.615Z
          definitionId: a0031fcd-269e-477f-923e-df7b78fdccfb
          secretId: '...my_secret_id...'
          workspaceId: d4150f21-ccba-4594-a601-68b3357ba468
    

    Create SourceWatchmode Resource

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

    Constructor syntax

    new SourceWatchmode(name: string, args: SourceWatchmodeArgs, opts?: CustomResourceOptions);
    @overload
    def SourceWatchmode(resource_name: str,
                        args: SourceWatchmodeArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def SourceWatchmode(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        configuration: Optional[SourceWatchmodeConfigurationArgs] = None,
                        workspace_id: Optional[str] = None,
                        definition_id: Optional[str] = None,
                        name: Optional[str] = None,
                        secret_id: Optional[str] = None)
    func NewSourceWatchmode(ctx *Context, name string, args SourceWatchmodeArgs, opts ...ResourceOption) (*SourceWatchmode, error)
    public SourceWatchmode(string name, SourceWatchmodeArgs args, CustomResourceOptions? opts = null)
    public SourceWatchmode(String name, SourceWatchmodeArgs args)
    public SourceWatchmode(String name, SourceWatchmodeArgs args, CustomResourceOptions options)
    
    type: airbyte:SourceWatchmode
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args SourceWatchmodeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SourceWatchmodeArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SourceWatchmodeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SourceWatchmodeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SourceWatchmodeArgs
    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 sourceWatchmodeResource = new Airbyte.SourceWatchmode("sourceWatchmodeResource", new()
    {
        Configuration = new Airbyte.Inputs.SourceWatchmodeConfigurationArgs
        {
            ApiKey = "string",
            StartDate = "string",
            SearchVal = "string",
        },
        WorkspaceId = "string",
        DefinitionId = "string",
        Name = "string",
        SecretId = "string",
    });
    
    example, err := airbyte.NewSourceWatchmode(ctx, "sourceWatchmodeResource", &airbyte.SourceWatchmodeArgs{
    	Configuration: &airbyte.SourceWatchmodeConfigurationArgs{
    		ApiKey:    pulumi.String("string"),
    		StartDate: pulumi.String("string"),
    		SearchVal: pulumi.String("string"),
    	},
    	WorkspaceId:  pulumi.String("string"),
    	DefinitionId: pulumi.String("string"),
    	Name:         pulumi.String("string"),
    	SecretId:     pulumi.String("string"),
    })
    
    var sourceWatchmodeResource = new SourceWatchmode("sourceWatchmodeResource", SourceWatchmodeArgs.builder()
        .configuration(SourceWatchmodeConfigurationArgs.builder()
            .apiKey("string")
            .startDate("string")
            .searchVal("string")
            .build())
        .workspaceId("string")
        .definitionId("string")
        .name("string")
        .secretId("string")
        .build());
    
    source_watchmode_resource = airbyte.SourceWatchmode("sourceWatchmodeResource",
        configuration={
            "api_key": "string",
            "start_date": "string",
            "search_val": "string",
        },
        workspace_id="string",
        definition_id="string",
        name="string",
        secret_id="string")
    
    const sourceWatchmodeResource = new airbyte.SourceWatchmode("sourceWatchmodeResource", {
        configuration: {
            apiKey: "string",
            startDate: "string",
            searchVal: "string",
        },
        workspaceId: "string",
        definitionId: "string",
        name: "string",
        secretId: "string",
    });
    
    type: airbyte:SourceWatchmode
    properties:
        configuration:
            apiKey: string
            searchVal: string
            startDate: string
        definitionId: string
        name: string
        secretId: string
        workspaceId: string
    

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

    Configuration SourceWatchmodeConfiguration
    WorkspaceId string
    DefinitionId string
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    Name string
    Name of the source e.g. dev-mysql-instance.
    SecretId string
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    Configuration SourceWatchmodeConfigurationArgs
    WorkspaceId string
    DefinitionId string
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    Name string
    Name of the source e.g. dev-mysql-instance.
    SecretId string
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    configuration SourceWatchmodeConfiguration
    workspaceId String
    definitionId String
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    name String
    Name of the source e.g. dev-mysql-instance.
    secretId String
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    configuration SourceWatchmodeConfiguration
    workspaceId string
    definitionId string
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    name string
    Name of the source e.g. dev-mysql-instance.
    secretId string
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    configuration SourceWatchmodeConfigurationArgs
    workspace_id str
    definition_id str
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    name str
    Name of the source e.g. dev-mysql-instance.
    secret_id str
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    configuration Property Map
    workspaceId String
    definitionId String
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    name String
    Name of the source e.g. dev-mysql-instance.
    secretId String
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SourceWatchmode resource produces the following output properties:

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

    Get an existing SourceWatchmode 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?: SourceWatchmodeState, opts?: CustomResourceOptions): SourceWatchmode
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            configuration: Optional[SourceWatchmodeConfigurationArgs] = None,
            created_at: Optional[float] = None,
            definition_id: Optional[str] = None,
            name: Optional[str] = None,
            resource_allocation: Optional[SourceWatchmodeResourceAllocationArgs] = None,
            secret_id: Optional[str] = None,
            source_id: Optional[str] = None,
            source_type: Optional[str] = None,
            workspace_id: Optional[str] = None) -> SourceWatchmode
    func GetSourceWatchmode(ctx *Context, name string, id IDInput, state *SourceWatchmodeState, opts ...ResourceOption) (*SourceWatchmode, error)
    public static SourceWatchmode Get(string name, Input<string> id, SourceWatchmodeState? state, CustomResourceOptions? opts = null)
    public static SourceWatchmode get(String name, Output<String> id, SourceWatchmodeState state, CustomResourceOptions options)
    resources:  _:    type: airbyte:SourceWatchmode    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Configuration SourceWatchmodeConfiguration
    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 SourceWatchmodeResourceAllocation
    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 SourceWatchmodeConfigurationArgs
    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 SourceWatchmodeResourceAllocationArgs
    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 SourceWatchmodeConfiguration
    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 SourceWatchmodeResourceAllocation
    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 SourceWatchmodeConfiguration
    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 SourceWatchmodeResourceAllocation
    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 SourceWatchmodeConfigurationArgs
    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 SourceWatchmodeResourceAllocationArgs
    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

    SourceWatchmodeConfiguration, SourceWatchmodeConfigurationArgs

    ApiKey string
    Your API key for authenticating with the Watchmode API. You can request a free API key at https://api.watchmode.com/requestApiKey/.
    StartDate string
    SearchVal string
    The name value for search stream. Default: "Terminator"
    ApiKey string
    Your API key for authenticating with the Watchmode API. You can request a free API key at https://api.watchmode.com/requestApiKey/.
    StartDate string
    SearchVal string
    The name value for search stream. Default: "Terminator"
    apiKey String
    Your API key for authenticating with the Watchmode API. You can request a free API key at https://api.watchmode.com/requestApiKey/.
    startDate String
    searchVal String
    The name value for search stream. Default: "Terminator"
    apiKey string
    Your API key for authenticating with the Watchmode API. You can request a free API key at https://api.watchmode.com/requestApiKey/.
    startDate string
    searchVal string
    The name value for search stream. Default: "Terminator"
    api_key str
    Your API key for authenticating with the Watchmode API. You can request a free API key at https://api.watchmode.com/requestApiKey/.
    start_date str
    search_val str
    The name value for search stream. Default: "Terminator"
    apiKey String
    Your API key for authenticating with the Watchmode API. You can request a free API key at https://api.watchmode.com/requestApiKey/.
    startDate String
    searchVal String
    The name value for search stream. Default: "Terminator"

    SourceWatchmodeResourceAllocation, SourceWatchmodeResourceAllocationArgs

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

    SourceWatchmodeResourceAllocationDefault, SourceWatchmodeResourceAllocationDefaultArgs

    SourceWatchmodeResourceAllocationJobSpecific, SourceWatchmodeResourceAllocationJobSpecificArgs

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

    SourceWatchmodeResourceAllocationJobSpecificResourceRequirements, SourceWatchmodeResourceAllocationJobSpecificResourceRequirementsArgs

    Import

    $ pulumi import airbyte:index/sourceWatchmode:SourceWatchmode my_airbyte_source_watchmode ""
    

    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 logo
    airbyte 0.10.0 published on Monday, Apr 14, 2025 by airbytehq