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

airbyte.SourceRedshift

Explore with Pulumi AI

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

    SourceRedshift 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.SourceRedshift;
import com.pulumi.airbyte.SourceRedshiftArgs;
import com.pulumi.airbyte.inputs.SourceRedshiftConfigurationArgs;
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 mySourceRedshift = new SourceRedshift("mySourceRedshift", SourceRedshiftArgs.builder()
            .configuration(SourceRedshiftConfigurationArgs.builder()
                .database("master")
                .host("...my_host...")
                .jdbc_url_params("...my_jdbc_url_params...")
                .password("...my_password...")
                .port(5439)
                .schemas()
                .username("...my_username...")
                .build())
            .definitionId("e25148e3-3c6f-4e5f-88e2-c90d1e9f9593")
            .secretId("...my_secret_id...")
            .workspaceId("84353b00-31b2-4302-bdea-2a56e10ac383")
            .build());

    }
}

    resources:
  mySourceRedshift:
    type: airbyte:SourceRedshift
    properties:
      configuration:
        database: master
        host: '...my_host...'
        jdbc_url_params: '...my_jdbc_url_params...'
        password: '...my_password...'
        port: 5439
        schemas: []
        username: '...my_username...'
      definitionId: e25148e3-3c6f-4e5f-88e2-c90d1e9f9593
      secretId: '...my_secret_id...'
      workspaceId: 84353b00-31b2-4302-bdea-2a56e10ac383

    Create SourceRedshift Resource

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

    Constructor syntax

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

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

    type: airbyte:SourceRedshift
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 SourceRedshiftArgs
    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 SourceRedshiftArgs
    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 SourceRedshiftArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SourceRedshiftArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SourceRedshiftArgs
    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 sourceRedshiftResource = new Airbyte.SourceRedshift("sourceRedshiftResource", new()
{
    Configuration = new Airbyte.Inputs.SourceRedshiftConfigurationArgs
    {
        Database = "string",
        Host = "string",
        Password = "string",
        Username = "string",
        JdbcUrlParams = "string",
        Port = 0,
        Schemas = new[]
        {
            "string",
        },
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});

    example, err := airbyte.NewSourceRedshift(ctx, "sourceRedshiftResource", &airbyte.SourceRedshiftArgs{
Configuration: &.SourceRedshiftConfigurationArgs{
Database: pulumi.String("string"),
Host: pulumi.String("string"),
Password: pulumi.String("string"),
Username: pulumi.String("string"),
JdbcUrlParams: pulumi.String("string"),
Port: pulumi.Float64(0),
Schemas: pulumi.StringArray{
pulumi.String("string"),
},
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})

    var sourceRedshiftResource = new SourceRedshift("sourceRedshiftResource", SourceRedshiftArgs.builder()
    .configuration(SourceRedshiftConfigurationArgs.builder()
        .database("string")
        .host("string")
        .password("string")
        .username("string")
        .jdbcUrlParams("string")
        .port(0)
        .schemas("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());

    source_redshift_resource = airbyte.SourceRedshift("sourceRedshiftResource",
    configuration={
        "database": "string",
        "host": "string",
        "password": "string",
        "username": "string",
        "jdbc_url_params": "string",
        "port": 0,
        "schemas": ["string"],
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")

    const sourceRedshiftResource = new airbyte.SourceRedshift("sourceRedshiftResource", {
    configuration: {
        database: "string",
        host: "string",
        password: "string",
        username: "string",
        jdbcUrlParams: "string",
        port: 0,
        schemas: ["string"],
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});

    type: airbyte:SourceRedshift
properties:
    configuration:
        database: string
        host: string
        jdbcUrlParams: string
        password: string
        port: 0
        schemas:
            - string
        username: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string

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

    Configuration SourceRedshiftConfiguration
    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 SourceRedshiftConfigurationArgs
    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 SourceRedshiftConfiguration
    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 SourceRedshiftConfiguration
    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 SourceRedshiftConfigurationArgs
    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 SourceRedshift 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 SourceRedshift Resource

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

    SourceRedshiftConfiguration, SourceRedshiftConfigurationArgs

    Database string
    Name of the database.
    Host string
    Host Endpoint of the Redshift Cluster (must include the cluster-id, region and end with .redshift.amazonaws.com).
    Password string
    Password associated with the username.
    Username string
    Username to use to access the database.
    JdbcUrlParams string
    Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (example: key1=value1&key2=value2&key3=value3).
    Port double
    Port of the database. Default: 5439
    Schemas List<string>
    The list of schemas to sync from. Specify one or more explicitly or keep empty to process all schemas. Schema names are case sensitive.
    Database string
    Name of the database.
    Host string
    Host Endpoint of the Redshift Cluster (must include the cluster-id, region and end with .redshift.amazonaws.com).
    Password string
    Password associated with the username.
    Username string
    Username to use to access the database.
    JdbcUrlParams string
    Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (example: key1=value1&key2=value2&key3=value3).
    Port float64
    Port of the database. Default: 5439
    Schemas []string
    The list of schemas to sync from. Specify one or more explicitly or keep empty to process all schemas. Schema names are case sensitive.
    database String
    Name of the database.
    host String
    Host Endpoint of the Redshift Cluster (must include the cluster-id, region and end with .redshift.amazonaws.com).
    password String
    Password associated with the username.
    username String
    Username to use to access the database.
    jdbcUrlParams String
    Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (example: key1=value1&key2=value2&key3=value3).
    port Double
    Port of the database. Default: 5439
    schemas List<String>
    The list of schemas to sync from. Specify one or more explicitly or keep empty to process all schemas. Schema names are case sensitive.
    database string
    Name of the database.
    host string
    Host Endpoint of the Redshift Cluster (must include the cluster-id, region and end with .redshift.amazonaws.com).
    password string
    Password associated with the username.
    username string
    Username to use to access the database.
    jdbcUrlParams string
    Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (example: key1=value1&key2=value2&key3=value3).
    port number
    Port of the database. Default: 5439
    schemas string[]
    The list of schemas to sync from. Specify one or more explicitly or keep empty to process all schemas. Schema names are case sensitive.
    database str
    Name of the database.
    host str
    Host Endpoint of the Redshift Cluster (must include the cluster-id, region and end with .redshift.amazonaws.com).
    password str
    Password associated with the username.
    username str
    Username to use to access the database.
    jdbc_url_params str
    Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (example: key1=value1&key2=value2&key3=value3).
    port float
    Port of the database. Default: 5439
    schemas Sequence[str]
    The list of schemas to sync from. Specify one or more explicitly or keep empty to process all schemas. Schema names are case sensitive.
    database String
    Name of the database.
    host String
    Host Endpoint of the Redshift Cluster (must include the cluster-id, region and end with .redshift.amazonaws.com).
    password String
    Password associated with the username.
    username String
    Username to use to access the database.
    jdbcUrlParams String
    Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (example: key1=value1&key2=value2&key3=value3).
    port Number
    Port of the database. Default: 5439
    schemas List<String>
    The list of schemas to sync from. Specify one or more explicitly or keep empty to process all schemas. Schema names are case sensitive.

    Import

    $ pulumi import airbyte:index/sourceRedshift:SourceRedshift my_airbyte_source_redshift ""

    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