airbyte 0.7.0-beta2, Mar 7 25

airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq

airbyte.SourceUnleash

Explore with Pulumi AI

airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq

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.SourceUnleash;
import com.pulumi.airbyte.SourceUnleashArgs;
import com.pulumi.airbyte.inputs.SourceUnleashConfigurationArgs;
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 mySourceUnleash = new SourceUnleash("mySourceUnleash", SourceUnleashArgs.builder()
            .configuration(SourceUnleashConfigurationArgs.builder()
                .api_token("project:environment.be44368985f7fb3237c584ef86f3d6bdada42ddbd63a019d26955178")
                .api_url("...my_api_url...")
                .nameprefix("...my_nameprefix...")
                .project_name("...my_project_name...")
                .build())
            .definitionId("6888cec3-c77f-42ae-92a4-31df920982a3")
            .secretId("...my_secret_id...")
            .workspaceId("42a458da-b1aa-4372-ad2a-7c80419e5bac")
            .build());

    }
}

resources:
  mySourceUnleash:
    type: airbyte:SourceUnleash
    properties:
      configuration:
        api_token: project:environment.be44368985f7fb3237c584ef86f3d6bdada42ddbd63a019d26955178
        api_url: '...my_api_url...'
        nameprefix: '...my_nameprefix...'
        project_name: '...my_project_name...'
      definitionId: 6888cec3-c77f-42ae-92a4-31df920982a3
      secretId: '...my_secret_id...'
      workspaceId: 42a458da-b1aa-4372-ad2a-7c80419e5bac

Create SourceUnleash Resource

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

Constructor syntax

new SourceUnleash(name: string, args: SourceUnleashArgs, opts?: CustomResourceOptions);

@overload
def SourceUnleash(resource_name: str,
                  args: SourceUnleashArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def SourceUnleash(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  configuration: Optional[SourceUnleashConfigurationArgs] = None,
                  workspace_id: Optional[str] = None,
                  definition_id: Optional[str] = None,
                  name: Optional[str] = None,
                  secret_id: Optional[str] = None)

func NewSourceUnleash(ctx *Context, name string, args SourceUnleashArgs, opts ...ResourceOption) (*SourceUnleash, error)

public SourceUnleash(string name, SourceUnleashArgs args, CustomResourceOptions? opts = null)

public SourceUnleash(String name, SourceUnleashArgs args)
public SourceUnleash(String name, SourceUnleashArgs args, CustomResourceOptions options)

type: airbyte:SourceUnleash
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 SourceUnleashArgs: 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 SourceUnleashArgs: 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 SourceUnleashArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args SourceUnleashArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args SourceUnleashArgs: 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 sourceUnleashResource = new Airbyte.SourceUnleash("sourceUnleashResource", new()
{
    Configuration = new Airbyte.Inputs.SourceUnleashConfigurationArgs
    {
        ApiToken = "string",
        ApiUrl = "string",
        Nameprefix = "string",
        ProjectName = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});

example, err := airbyte.NewSourceUnleash(ctx, "sourceUnleashResource", &airbyte.SourceUnleashArgs{
Configuration: &.SourceUnleashConfigurationArgs{
ApiToken: pulumi.String("string"),
ApiUrl: pulumi.String("string"),
Nameprefix: pulumi.String("string"),
ProjectName: pulumi.String("string"),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})

var sourceUnleashResource = new SourceUnleash("sourceUnleashResource", SourceUnleashArgs.builder()
    .configuration(SourceUnleashConfigurationArgs.builder()
        .apiToken("string")
        .apiUrl("string")
        .nameprefix("string")
        .projectName("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());

source_unleash_resource = airbyte.SourceUnleash("sourceUnleashResource",
    configuration={
        "api_token": "string",
        "api_url": "string",
        "nameprefix": "string",
        "project_name": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")

const sourceUnleashResource = new airbyte.SourceUnleash("sourceUnleashResource", {
    configuration: {
        apiToken: "string",
        apiUrl: "string",
        nameprefix: "string",
        projectName: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});

type: airbyte:SourceUnleash
properties:
    configuration:
        apiToken: string
        apiUrl: string
        nameprefix: string
        projectName: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string

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

Configuration SourceUnleashConfiguration
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 SourceUnleashConfigurationArgs
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 SourceUnleashConfiguration
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 SourceUnleashConfiguration
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 SourceUnleashConfigurationArgs
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 SourceUnleash 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 SourceUnleash Resource

Get an existing SourceUnleash 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?: SourceUnleashState, opts?: CustomResourceOptions): SourceUnleash

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourceUnleashConfigurationArgs] = 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) -> SourceUnleash

func GetSourceUnleash(ctx *Context, name string, id IDInput, state *SourceUnleashState, opts ...ResourceOption) (*SourceUnleash, error)

public static SourceUnleash Get(string name, Input<string> id, SourceUnleashState? state, CustomResourceOptions? opts = null)

public static SourceUnleash get(String name, Output<String> id, SourceUnleashState state, CustomResourceOptions options)

resources:  _:    type: airbyte:SourceUnleash    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 SourceUnleashConfiguration
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 SourceUnleashConfigurationArgs
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 SourceUnleashConfiguration
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 SourceUnleashConfiguration
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 SourceUnleashConfigurationArgs
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

SourceUnleashConfiguration, SourceUnleashConfigurationArgs

ApiToken string: Your API Token (Server-Side SDK [Client]). See \n\nhere\n\n. The token is case sensitive.
ApiUrl string: Your API URL. No trailing slash. ex: https://unleash.host.com/api
Nameprefix string: Use this if you want to filter the API call for only one given project (can be used in addition to the "Feature Name Prefix" field). See \n\nhere\n\n
ProjectName string: Use this if you want to filter the API call for only one given project (can be used in addition to the "Feature Name Prefix" field). See \n\nhere\n\n

ApiToken string: Your API Token (Server-Side SDK [Client]). See \n\nhere\n\n. The token is case sensitive.
ApiUrl string: Your API URL. No trailing slash. ex: https://unleash.host.com/api
Nameprefix string: Use this if you want to filter the API call for only one given project (can be used in addition to the "Feature Name Prefix" field). See \n\nhere\n\n
ProjectName string: Use this if you want to filter the API call for only one given project (can be used in addition to the "Feature Name Prefix" field). See \n\nhere\n\n

apiToken String: Your API Token (Server-Side SDK [Client]). See \n\nhere\n\n. The token is case sensitive.
apiUrl String: Your API URL. No trailing slash. ex: https://unleash.host.com/api
nameprefix String: Use this if you want to filter the API call for only one given project (can be used in addition to the "Feature Name Prefix" field). See \n\nhere\n\n
projectName String: Use this if you want to filter the API call for only one given project (can be used in addition to the "Feature Name Prefix" field). See \n\nhere\n\n

apiToken string: Your API Token (Server-Side SDK [Client]). See \n\nhere\n\n. The token is case sensitive.
apiUrl string: Your API URL. No trailing slash. ex: https://unleash.host.com/api
nameprefix string: Use this if you want to filter the API call for only one given project (can be used in addition to the "Feature Name Prefix" field). See \n\nhere\n\n
projectName string: Use this if you want to filter the API call for only one given project (can be used in addition to the "Feature Name Prefix" field). See \n\nhere\n\n

api_token str: Your API Token (Server-Side SDK [Client]). See \n\nhere\n\n. The token is case sensitive.
api_url str: Your API URL. No trailing slash. ex: https://unleash.host.com/api
nameprefix str: Use this if you want to filter the API call for only one given project (can be used in addition to the "Feature Name Prefix" field). See \n\nhere\n\n
project_name str: Use this if you want to filter the API call for only one given project (can be used in addition to the "Feature Name Prefix" field). See \n\nhere\n\n

apiToken String: Your API Token (Server-Side SDK [Client]). See \n\nhere\n\n. The token is case sensitive.
apiUrl String: Your API URL. No trailing slash. ex: https://unleash.host.com/api
nameprefix String: Use this if you want to filter the API call for only one given project (can be used in addition to the "Feature Name Prefix" field). See \n\nhere\n\n
projectName String: Use this if you want to filter the API call for only one given project (can be used in addition to the "Feature Name Prefix" field). See \n\nhere\n\n

Import

$ pulumi import airbyte:index/sourceUnleash:SourceUnleash my_airbyte_source_unleash ""

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 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq

airbytehq/terraform-provider-airbyte

airbyte.SourceUnleash

On this page

On this page

Example Usage

Create SourceUnleash Resource

Constructor syntax

Parameters

Constructor example

SourceUnleash Resource Properties

Inputs

Outputs

Look up Existing SourceUnleash Resource

Supporting Types

SourceUnleashConfiguration, SourceUnleashConfigurationArgs

Import

Package Details

On this page

On this page