1. Packages
  2. Airbyte Provider
  3. API Docs
  4. SourceFront
airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq

airbyte.SourceFront

Explore with Pulumi AI

SourceFront 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.SourceFront;
import com.pulumi.airbyte.SourceFrontArgs;
import com.pulumi.airbyte.inputs.SourceFrontConfigurationArgs;
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 mySourceFront = new SourceFront("mySourceFront", SourceFrontArgs.builder()
            .configuration(SourceFrontConfigurationArgs.builder()
                .api_key("...my_api_key...")
                .page_limit("...my_page_limit...")
                .start_date("2021-03-09T10:03:43.663Z")
                .build())
            .definitionId("e1a19bd4-87cb-4e60-b701-5a81b05d6c35")
            .secretId("...my_secret_id...")
            .workspaceId("8be9bca5-1753-4d9a-88e9-0ead4ee93908")
            .build());

    }
}
Copy
resources:
  mySourceFront:
    type: airbyte:SourceFront
    properties:
      configuration:
        api_key: '...my_api_key...'
        page_limit: '...my_page_limit...'
        start_date: 2021-03-09T10:03:43.663Z
      definitionId: e1a19bd4-87cb-4e60-b701-5a81b05d6c35
      secretId: '...my_secret_id...'
      workspaceId: 8be9bca5-1753-4d9a-88e9-0ead4ee93908
Copy

Create SourceFront Resource

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

Constructor syntax

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

@overload
def SourceFront(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                configuration: Optional[SourceFrontConfigurationArgs] = None,
                workspace_id: Optional[str] = None,
                definition_id: Optional[str] = None,
                name: Optional[str] = None,
                secret_id: Optional[str] = None)
func NewSourceFront(ctx *Context, name string, args SourceFrontArgs, opts ...ResourceOption) (*SourceFront, error)
public SourceFront(string name, SourceFrontArgs args, CustomResourceOptions? opts = null)
public SourceFront(String name, SourceFrontArgs args)
public SourceFront(String name, SourceFrontArgs args, CustomResourceOptions options)
type: airbyte:SourceFront
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. SourceFrontArgs
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. SourceFrontArgs
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. SourceFrontArgs
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. SourceFrontArgs
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. SourceFrontArgs
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 sourceFrontResource = new Airbyte.SourceFront("sourceFrontResource", new()
{
    Configuration = new Airbyte.Inputs.SourceFrontConfigurationArgs
    {
        ApiKey = "string",
        StartDate = "string",
        PageLimit = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});
Copy
example, err := airbyte.NewSourceFront(ctx, "sourceFrontResource", &airbyte.SourceFrontArgs{
Configuration: &.SourceFrontConfigurationArgs{
ApiKey: pulumi.String("string"),
StartDate: pulumi.String("string"),
PageLimit: pulumi.String("string"),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})
Copy
var sourceFrontResource = new SourceFront("sourceFrontResource", SourceFrontArgs.builder()
    .configuration(SourceFrontConfigurationArgs.builder()
        .apiKey("string")
        .startDate("string")
        .pageLimit("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());
Copy
source_front_resource = airbyte.SourceFront("sourceFrontResource",
    configuration={
        "api_key": "string",
        "start_date": "string",
        "page_limit": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")
Copy
const sourceFrontResource = new airbyte.SourceFront("sourceFrontResource", {
    configuration: {
        apiKey: "string",
        startDate: "string",
        pageLimit: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});
Copy
type: airbyte:SourceFront
properties:
    configuration:
        apiKey: string
        pageLimit: string
        startDate: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string
Copy

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

Configuration This property is required. SourceFrontConfiguration
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. SourceFrontConfigurationArgs
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. SourceFrontConfiguration
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. SourceFrontConfiguration
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. SourceFrontConfigurationArgs
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 SourceFront resource produces the following output properties:

CreatedAt double
Id string
The provider-assigned unique ID for this managed resource.
SourceId string
SourceType string
CreatedAt float64
Id string
The provider-assigned unique ID for this managed resource.
SourceId string
SourceType string
createdAt Double
id String
The provider-assigned unique ID for this managed resource.
sourceId String
sourceType String
createdAt number
id string
The provider-assigned unique ID for this managed resource.
sourceId string
sourceType string
created_at float
id str
The provider-assigned unique ID for this managed resource.
source_id str
source_type str
createdAt Number
id String
The provider-assigned unique ID for this managed resource.
sourceId String
sourceType String

Look up Existing SourceFront Resource

Get an existing SourceFront 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?: SourceFrontState, opts?: CustomResourceOptions): SourceFront
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourceFrontConfigurationArgs] = None,
        created_at: Optional[float] = None,
        definition_id: Optional[str] = None,
        name: Optional[str] = None,
        secret_id: Optional[str] = None,
        source_id: Optional[str] = None,
        source_type: Optional[str] = None,
        workspace_id: Optional[str] = None) -> SourceFront
func GetSourceFront(ctx *Context, name string, id IDInput, state *SourceFrontState, opts ...ResourceOption) (*SourceFront, error)
public static SourceFront Get(string name, Input<string> id, SourceFrontState? state, CustomResourceOptions? opts = null)
public static SourceFront get(String name, Output<String> id, SourceFrontState state, CustomResourceOptions options)
resources:  _:    type: airbyte:SourceFront    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 SourceFrontConfiguration
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.
SecretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
SourceId string
SourceType string
WorkspaceId string
Configuration SourceFrontConfigurationArgs
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.
SecretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
SourceId string
SourceType string
WorkspaceId string
configuration SourceFrontConfiguration
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.
secretId String
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId String
sourceType String
workspaceId String
configuration SourceFrontConfiguration
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.
secretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId string
sourceType string
workspaceId string
configuration SourceFrontConfigurationArgs
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.
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.
secretId String
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId String
sourceType String
workspaceId String

Supporting Types

SourceFrontConfiguration
, SourceFrontConfigurationArgs

ApiKey This property is required. string
StartDate This property is required. string
PageLimit string
Page limit for the responses. Default: "50"
ApiKey This property is required. string
StartDate This property is required. string
PageLimit string
Page limit for the responses. Default: "50"
apiKey This property is required. String
startDate This property is required. String
pageLimit String
Page limit for the responses. Default: "50"
apiKey This property is required. string
startDate This property is required. string
pageLimit string
Page limit for the responses. Default: "50"
api_key This property is required. str
start_date This property is required. str
page_limit str
Page limit for the responses. Default: "50"
apiKey This property is required. String
startDate This property is required. String
pageLimit String
Page limit for the responses. Default: "50"

Import

$ pulumi import airbyte:index/sourceFront:SourceFront my_airbyte_source_front ""
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.