Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Airbyte Provider
  3. API Docs
  4. SourceSegment
airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq
airbytehq/terraform-provider-airbyte

airbyte.SourceSegment

Explore with Pulumi AI

airbyte logo
airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq
airbytehq/terraform-provider-airbyte

    SourceSegment 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.SourceSegment;
import com.pulumi.airbyte.SourceSegmentArgs;
import com.pulumi.airbyte.inputs.SourceSegmentConfigurationArgs;
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 mySourceSegment = new SourceSegment("mySourceSegment", SourceSegmentArgs.builder()
            .configuration(SourceSegmentConfigurationArgs.builder()
                .api_token("...my_api_token...")
                .region("...my_region...")
                .start_date("2022-11-14T08:31:01.843Z")
                .build())
            .definitionId("44d4bfbf-aa80-4039-843e-7ddfeae40232")
            .secretId("...my_secret_id...")
            .workspaceId("27ef5c40-7227-4409-b731-b674609b3dd3")
            .build());

    }
}

    resources:
  mySourceSegment:
    type: airbyte:SourceSegment
    properties:
      configuration:
        api_token: '...my_api_token...'
        region: '...my_region...'
        start_date: 2022-11-14T08:31:01.843Z
      definitionId: 44d4bfbf-aa80-4039-843e-7ddfeae40232
      secretId: '...my_secret_id...'
      workspaceId: 27ef5c40-7227-4409-b731-b674609b3dd3

    Create SourceSegment Resource

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

    Constructor syntax

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

@overload
def SourceSegment(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  configuration: Optional[SourceSegmentConfigurationArgs] = None,
                  workspace_id: Optional[str] = None,
                  definition_id: Optional[str] = None,
                  name: Optional[str] = None,
                  secret_id: Optional[str] = None)
    func NewSourceSegment(ctx *Context, name string, args SourceSegmentArgs, opts ...ResourceOption) (*SourceSegment, error)
    public SourceSegment(string name, SourceSegmentArgs args, CustomResourceOptions? opts = null)
    public SourceSegment(String name, SourceSegmentArgs args)
public SourceSegment(String name, SourceSegmentArgs args, CustomResourceOptions options)

    type: airbyte:SourceSegment
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 SourceSegmentArgs
    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 SourceSegmentArgs
    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 SourceSegmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SourceSegmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SourceSegmentArgs
    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 sourceSegmentResource = new Airbyte.SourceSegment("sourceSegmentResource", new()
{
    Configuration = new Airbyte.Inputs.SourceSegmentConfigurationArgs
    {
        ApiToken = "string",
        StartDate = "string",
        Region = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});

    example, err := airbyte.NewSourceSegment(ctx, "sourceSegmentResource", &airbyte.SourceSegmentArgs{
Configuration: &.SourceSegmentConfigurationArgs{
ApiToken: pulumi.String("string"),
StartDate: pulumi.String("string"),
Region: pulumi.String("string"),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})

    var sourceSegmentResource = new SourceSegment("sourceSegmentResource", SourceSegmentArgs.builder()
    .configuration(SourceSegmentConfigurationArgs.builder()
        .apiToken("string")
        .startDate("string")
        .region("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());

    source_segment_resource = airbyte.SourceSegment("sourceSegmentResource",
    configuration={
        "api_token": "string",
        "start_date": "string",
        "region": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")

    const sourceSegmentResource = new airbyte.SourceSegment("sourceSegmentResource", {
    configuration: {
        apiToken: "string",
        startDate: "string",
        region: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});

    type: airbyte:SourceSegment
properties:
    configuration:
        apiToken: string
        region: string
        startDate: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string

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

    Configuration SourceSegmentConfiguration
    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 SourceSegmentConfigurationArgs
    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 SourceSegmentConfiguration
    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 SourceSegmentConfiguration
    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 SourceSegmentConfigurationArgs
    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 SourceSegment 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 SourceSegment Resource

    Get an existing SourceSegment 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?: SourceSegmentState, opts?: CustomResourceOptions): SourceSegment
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourceSegmentConfigurationArgs] = 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) -> SourceSegment
    func GetSourceSegment(ctx *Context, name string, id IDInput, state *SourceSegmentState, opts ...ResourceOption) (*SourceSegment, error)
    public static SourceSegment Get(string name, Input<string> id, SourceSegmentState? state, CustomResourceOptions? opts = null)
    public static SourceSegment get(String name, Output<String> id, SourceSegmentState state, CustomResourceOptions options)
    resources:  _:    type: airbyte:SourceSegment    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 SourceSegmentConfiguration
    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 SourceSegmentConfigurationArgs
    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 SourceSegmentConfiguration
    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 SourceSegmentConfiguration
    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 SourceSegmentConfigurationArgs
    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

    SourceSegmentConfiguration, SourceSegmentConfigurationArgs

    ApiToken string
    API token to use. Generate it in Segment's Workspace settings.
    StartDate string
    Region string
    The region for the API, e.g., 'api' for US or 'eu1' for EU. Default: "api"
    ApiToken string
    API token to use. Generate it in Segment's Workspace settings.
    StartDate string
    Region string
    The region for the API, e.g., 'api' for US or 'eu1' for EU. Default: "api"
    apiToken String
    API token to use. Generate it in Segment's Workspace settings.
    startDate String
    region String
    The region for the API, e.g., 'api' for US or 'eu1' for EU. Default: "api"
    apiToken string
    API token to use. Generate it in Segment's Workspace settings.
    startDate string
    region string
    The region for the API, e.g., 'api' for US or 'eu1' for EU. Default: "api"
    api_token str
    API token to use. Generate it in Segment's Workspace settings.
    start_date str
    region str
    The region for the API, e.g., 'api' for US or 'eu1' for EU. Default: "api"
    apiToken String
    API token to use. Generate it in Segment's Workspace settings.
    startDate String
    region String
    The region for the API, e.g., 'api' for US or 'eu1' for EU. Default: "api"

    Import

    $ pulumi import airbyte:index/sourceSegment:SourceSegment my_airbyte_source_segment ""

    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.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq
    airbytehq/terraform-provider-airbyte