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

airbyte.SourceOutreach

Explore with Pulumi AI

SourceOutreach 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.SourceOutreach;
import com.pulumi.airbyte.SourceOutreachArgs;
import com.pulumi.airbyte.inputs.SourceOutreachConfigurationArgs;
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 mySourceOutreach = new SourceOutreach("mySourceOutreach", SourceOutreachArgs.builder()
            .configuration(SourceOutreachConfigurationArgs.builder()
                .client_id("...my_client_id...")
                .client_secret("...my_client_secret...")
                .redirect_uri("...my_redirect_uri...")
                .refresh_token("...my_refresh_token...")
                .start_date("2020-11-16T00:00:00.000Z")
                .build())
            .definitionId("41648eec-a1c3-45f3-ba36-fe8c53db7a98")
            .secretId("...my_secret_id...")
            .workspaceId("f594140b-f616-4961-9529-4b6bdebbb064")
            .build());

    }
}
Copy
resources:
  mySourceOutreach:
    type: airbyte:SourceOutreach
    properties:
      configuration:
        client_id: '...my_client_id...'
        client_secret: '...my_client_secret...'
        redirect_uri: '...my_redirect_uri...'
        refresh_token: '...my_refresh_token...'
        start_date: 2020-11-16T00:00:00.000Z
      definitionId: 41648eec-a1c3-45f3-ba36-fe8c53db7a98
      secretId: '...my_secret_id...'
      workspaceId: f594140b-f616-4961-9529-4b6bdebbb064
Copy

Create SourceOutreach Resource

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

Constructor syntax

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

@overload
def SourceOutreach(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   configuration: Optional[SourceOutreachConfigurationArgs] = None,
                   workspace_id: Optional[str] = None,
                   definition_id: Optional[str] = None,
                   name: Optional[str] = None,
                   secret_id: Optional[str] = None)
func NewSourceOutreach(ctx *Context, name string, args SourceOutreachArgs, opts ...ResourceOption) (*SourceOutreach, error)
public SourceOutreach(string name, SourceOutreachArgs args, CustomResourceOptions? opts = null)
public SourceOutreach(String name, SourceOutreachArgs args)
public SourceOutreach(String name, SourceOutreachArgs args, CustomResourceOptions options)
type: airbyte:SourceOutreach
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. SourceOutreachArgs
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. SourceOutreachArgs
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. SourceOutreachArgs
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. SourceOutreachArgs
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. SourceOutreachArgs
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 sourceOutreachResource = new Airbyte.SourceOutreach("sourceOutreachResource", new()
{
    Configuration = new Airbyte.Inputs.SourceOutreachConfigurationArgs
    {
        ClientId = "string",
        ClientSecret = "string",
        RedirectUri = "string",
        RefreshToken = "string",
        StartDate = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});
Copy
example, err := airbyte.NewSourceOutreach(ctx, "sourceOutreachResource", &airbyte.SourceOutreachArgs{
Configuration: &.SourceOutreachConfigurationArgs{
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
RedirectUri: pulumi.String("string"),
RefreshToken: pulumi.String("string"),
StartDate: pulumi.String("string"),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})
Copy
var sourceOutreachResource = new SourceOutreach("sourceOutreachResource", SourceOutreachArgs.builder()
    .configuration(SourceOutreachConfigurationArgs.builder()
        .clientId("string")
        .clientSecret("string")
        .redirectUri("string")
        .refreshToken("string")
        .startDate("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());
Copy
source_outreach_resource = airbyte.SourceOutreach("sourceOutreachResource",
    configuration={
        "client_id": "string",
        "client_secret": "string",
        "redirect_uri": "string",
        "refresh_token": "string",
        "start_date": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")
Copy
const sourceOutreachResource = new airbyte.SourceOutreach("sourceOutreachResource", {
    configuration: {
        clientId: "string",
        clientSecret: "string",
        redirectUri: "string",
        refreshToken: "string",
        startDate: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});
Copy
type: airbyte:SourceOutreach
properties:
    configuration:
        clientId: string
        clientSecret: string
        redirectUri: string
        refreshToken: string
        startDate: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string
Copy

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

Configuration This property is required. SourceOutreachConfiguration
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. SourceOutreachConfigurationArgs
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. SourceOutreachConfiguration
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. SourceOutreachConfiguration
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. SourceOutreachConfigurationArgs
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 SourceOutreach resource produces the following output properties:

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

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

SourceOutreachConfiguration
, SourceOutreachConfigurationArgs

ClientId This property is required. string
The Client ID of your Outreach developer application.
ClientSecret This property is required. string
The Client Secret of your Outreach developer application.
RedirectUri This property is required. string
A Redirect URI is the location where the authorization server sends the user once the app has been successfully authorized and granted an authorization code or access token.
RefreshToken This property is required. string
The token for obtaining the new access token.
StartDate This property is required. string
The date from which you'd like to replicate data for Outreach API, in the format YYYY-MM-DDT00:00:00.000Z. All data generated after this date will be replicated.
ClientId This property is required. string
The Client ID of your Outreach developer application.
ClientSecret This property is required. string
The Client Secret of your Outreach developer application.
RedirectUri This property is required. string
A Redirect URI is the location where the authorization server sends the user once the app has been successfully authorized and granted an authorization code or access token.
RefreshToken This property is required. string
The token for obtaining the new access token.
StartDate This property is required. string
The date from which you'd like to replicate data for Outreach API, in the format YYYY-MM-DDT00:00:00.000Z. All data generated after this date will be replicated.
clientId This property is required. String
The Client ID of your Outreach developer application.
clientSecret This property is required. String
The Client Secret of your Outreach developer application.
redirectUri This property is required. String
A Redirect URI is the location where the authorization server sends the user once the app has been successfully authorized and granted an authorization code or access token.
refreshToken This property is required. String
The token for obtaining the new access token.
startDate This property is required. String
The date from which you'd like to replicate data for Outreach API, in the format YYYY-MM-DDT00:00:00.000Z. All data generated after this date will be replicated.
clientId This property is required. string
The Client ID of your Outreach developer application.
clientSecret This property is required. string
The Client Secret of your Outreach developer application.
redirectUri This property is required. string
A Redirect URI is the location where the authorization server sends the user once the app has been successfully authorized and granted an authorization code or access token.
refreshToken This property is required. string
The token for obtaining the new access token.
startDate This property is required. string
The date from which you'd like to replicate data for Outreach API, in the format YYYY-MM-DDT00:00:00.000Z. All data generated after this date will be replicated.
client_id This property is required. str
The Client ID of your Outreach developer application.
client_secret This property is required. str
The Client Secret of your Outreach developer application.
redirect_uri This property is required. str
A Redirect URI is the location where the authorization server sends the user once the app has been successfully authorized and granted an authorization code or access token.
refresh_token This property is required. str
The token for obtaining the new access token.
start_date This property is required. str
The date from which you'd like to replicate data for Outreach API, in the format YYYY-MM-DDT00:00:00.000Z. All data generated after this date will be replicated.
clientId This property is required. String
The Client ID of your Outreach developer application.
clientSecret This property is required. String
The Client Secret of your Outreach developer application.
redirectUri This property is required. String
A Redirect URI is the location where the authorization server sends the user once the app has been successfully authorized and granted an authorization code or access token.
refreshToken This property is required. String
The token for obtaining the new access token.
startDate This property is required. String
The date from which you'd like to replicate data for Outreach API, in the format YYYY-MM-DDT00:00:00.000Z. All data generated after this date will be replicated.

SourceOutreachResourceAllocation
, SourceOutreachResourceAllocationArgs

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

SourceOutreachResourceAllocationDefault
, SourceOutreachResourceAllocationDefaultArgs

SourceOutreachResourceAllocationJobSpecific
, SourceOutreachResourceAllocationJobSpecificArgs

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

SourceOutreachResourceAllocationJobSpecificResourceRequirements
, SourceOutreachResourceAllocationJobSpecificResourceRequirementsArgs

Import

$ pulumi import airbyte:index/sourceOutreach:SourceOutreach my_airbyte_source_outreach ""
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.