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

airbyte.SourcePoplar

Explore with Pulumi AI

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

    SourcePoplar 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.SourcePoplar;
    import com.pulumi.airbyte.SourcePoplarArgs;
    import com.pulumi.airbyte.inputs.SourcePoplarConfigurationArgs;
    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 mySourcePoplar = new SourcePoplar("mySourcePoplar", SourcePoplarArgs.builder()
                .configuration(SourcePoplarConfigurationArgs.builder()
                    .access_token("...my_access_token...")
                    .start_date("2022-04-18T20:53:52.720Z")
                    .build())
                .definitionId("762e3001-6edb-4979-8bc5-5c4d9f862232")
                .secretId("...my_secret_id...")
                .workspaceId("d5e8c4ce-fc79-41ce-a312-1e9b3d367285")
                .build());
    
        }
    }
    
    resources:
      mySourcePoplar:
        type: airbyte:SourcePoplar
        properties:
          configuration:
            access_token: '...my_access_token...'
            start_date: 2022-04-18T20:53:52.720Z
          definitionId: 762e3001-6edb-4979-8bc5-5c4d9f862232
          secretId: '...my_secret_id...'
          workspaceId: d5e8c4ce-fc79-41ce-a312-1e9b3d367285
    

    Create SourcePoplar Resource

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

    Constructor syntax

    new SourcePoplar(name: string, args: SourcePoplarArgs, opts?: CustomResourceOptions);
    @overload
    def SourcePoplar(resource_name: str,
                     args: SourcePoplarArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def SourcePoplar(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     configuration: Optional[SourcePoplarConfigurationArgs] = None,
                     workspace_id: Optional[str] = None,
                     definition_id: Optional[str] = None,
                     name: Optional[str] = None,
                     secret_id: Optional[str] = None)
    func NewSourcePoplar(ctx *Context, name string, args SourcePoplarArgs, opts ...ResourceOption) (*SourcePoplar, error)
    public SourcePoplar(string name, SourcePoplarArgs args, CustomResourceOptions? opts = null)
    public SourcePoplar(String name, SourcePoplarArgs args)
    public SourcePoplar(String name, SourcePoplarArgs args, CustomResourceOptions options)
    
    type: airbyte:SourcePoplar
    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 SourcePoplarArgs
    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 SourcePoplarArgs
    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 SourcePoplarArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SourcePoplarArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SourcePoplarArgs
    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 sourcePoplarResource = new Airbyte.SourcePoplar("sourcePoplarResource", new()
    {
        Configuration = new Airbyte.Inputs.SourcePoplarConfigurationArgs
        {
            AccessToken = "string",
            StartDate = "string",
        },
        WorkspaceId = "string",
        DefinitionId = "string",
        Name = "string",
        SecretId = "string",
    });
    
    example, err := airbyte.NewSourcePoplar(ctx, "sourcePoplarResource", &airbyte.SourcePoplarArgs{
    	Configuration: &airbyte.SourcePoplarConfigurationArgs{
    		AccessToken: pulumi.String("string"),
    		StartDate:   pulumi.String("string"),
    	},
    	WorkspaceId:  pulumi.String("string"),
    	DefinitionId: pulumi.String("string"),
    	Name:         pulumi.String("string"),
    	SecretId:     pulumi.String("string"),
    })
    
    var sourcePoplarResource = new SourcePoplar("sourcePoplarResource", SourcePoplarArgs.builder()
        .configuration(SourcePoplarConfigurationArgs.builder()
            .accessToken("string")
            .startDate("string")
            .build())
        .workspaceId("string")
        .definitionId("string")
        .name("string")
        .secretId("string")
        .build());
    
    source_poplar_resource = airbyte.SourcePoplar("sourcePoplarResource",
        configuration={
            "access_token": "string",
            "start_date": "string",
        },
        workspace_id="string",
        definition_id="string",
        name="string",
        secret_id="string")
    
    const sourcePoplarResource = new airbyte.SourcePoplar("sourcePoplarResource", {
        configuration: {
            accessToken: "string",
            startDate: "string",
        },
        workspaceId: "string",
        definitionId: "string",
        name: "string",
        secretId: "string",
    });
    
    type: airbyte:SourcePoplar
    properties:
        configuration:
            accessToken: string
            startDate: string
        definitionId: string
        name: string
        secretId: string
        workspaceId: string
    

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

    Configuration SourcePoplarConfiguration
    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 SourcePoplarConfigurationArgs
    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 SourcePoplarConfiguration
    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 SourcePoplarConfiguration
    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 SourcePoplarConfigurationArgs
    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 SourcePoplar resource produces the following output properties:

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

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

    SourcePoplarConfiguration, SourcePoplarConfigurationArgs

    AccessToken string
    Your Poplar API Access Token. Generate it from the API Credentials page in your account. Use a production token for live data or a test token for testing purposes.
    StartDate string
    AccessToken string
    Your Poplar API Access Token. Generate it from the API Credentials page in your account. Use a production token for live data or a test token for testing purposes.
    StartDate string
    accessToken String
    Your Poplar API Access Token. Generate it from the API Credentials page in your account. Use a production token for live data or a test token for testing purposes.
    startDate String
    accessToken string
    Your Poplar API Access Token. Generate it from the API Credentials page in your account. Use a production token for live data or a test token for testing purposes.
    startDate string
    access_token str
    Your Poplar API Access Token. Generate it from the API Credentials page in your account. Use a production token for live data or a test token for testing purposes.
    start_date str
    accessToken String
    Your Poplar API Access Token. Generate it from the API Credentials page in your account. Use a production token for live data or a test token for testing purposes.
    startDate String

    SourcePoplarResourceAllocation, SourcePoplarResourceAllocationArgs

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

    SourcePoplarResourceAllocationDefault, SourcePoplarResourceAllocationDefaultArgs

    SourcePoplarResourceAllocationJobSpecific, SourcePoplarResourceAllocationJobSpecificArgs

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

    SourcePoplarResourceAllocationJobSpecificResourceRequirements, SourcePoplarResourceAllocationJobSpecificResourceRequirementsArgs

    Import

    $ pulumi import airbyte:index/sourcePoplar:SourcePoplar my_airbyte_source_poplar ""
    

    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