airbyte 0.7.0-beta2, Mar 7 25

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

airbyte.SourceGocardless

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.SourceGocardless;
import com.pulumi.airbyte.SourceGocardlessArgs;
import com.pulumi.airbyte.inputs.SourceGocardlessConfigurationArgs;
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 mySourceGocardless = new SourceGocardless("mySourceGocardless", SourceGocardlessArgs.builder()
            .configuration(SourceGocardlessConfigurationArgs.builder()
                .access_token("...my_access_token...")
                .gocardless_environment("live")
                .gocardless_version("...my_gocardless_version...")
                .start_date("2017-01-25T00:00:00Z")
                .build())
            .definitionId("43590505-e230-4e7f-89a3-c3411383f4c6")
            .secretId("...my_secret_id...")
            .workspaceId("4d1ab77a-3011-4b9d-b930-4a6a9c6213fb")
            .build());

    }
}

resources:
  mySourceGocardless:
    type: airbyte:SourceGocardless
    properties:
      configuration:
        access_token: '...my_access_token...'
        gocardless_environment: live
        gocardless_version: '...my_gocardless_version...'
        start_date: 2017-01-25T00:00:00Z
      definitionId: 43590505-e230-4e7f-89a3-c3411383f4c6
      secretId: '...my_secret_id...'
      workspaceId: 4d1ab77a-3011-4b9d-b930-4a6a9c6213fb

Create SourceGocardless Resource

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

Constructor syntax

new SourceGocardless(name: string, args: SourceGocardlessArgs, opts?: CustomResourceOptions);

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

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

func NewSourceGocardless(ctx *Context, name string, args SourceGocardlessArgs, opts ...ResourceOption) (*SourceGocardless, error)

public SourceGocardless(string name, SourceGocardlessArgs args, CustomResourceOptions? opts = null)

public SourceGocardless(String name, SourceGocardlessArgs args)
public SourceGocardless(String name, SourceGocardlessArgs args, CustomResourceOptions options)

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

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

name String: The unique name of the resource.
args SourceGocardlessArgs: 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 sourceGocardlessResource = new Airbyte.SourceGocardless("sourceGocardlessResource", new()
{
    Configuration = new Airbyte.Inputs.SourceGocardlessConfigurationArgs
    {
        AccessToken = "string",
        GocardlessVersion = "string",
        StartDate = "string",
        GocardlessEnvironment = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});

example, err := airbyte.NewSourceGocardless(ctx, "sourceGocardlessResource", &airbyte.SourceGocardlessArgs{
Configuration: &.SourceGocardlessConfigurationArgs{
AccessToken: pulumi.String("string"),
GocardlessVersion: pulumi.String("string"),
StartDate: pulumi.String("string"),
GocardlessEnvironment: pulumi.String("string"),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})

var sourceGocardlessResource = new SourceGocardless("sourceGocardlessResource", SourceGocardlessArgs.builder()
    .configuration(SourceGocardlessConfigurationArgs.builder()
        .accessToken("string")
        .gocardlessVersion("string")
        .startDate("string")
        .gocardlessEnvironment("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());

source_gocardless_resource = airbyte.SourceGocardless("sourceGocardlessResource",
    configuration={
        "access_token": "string",
        "gocardless_version": "string",
        "start_date": "string",
        "gocardless_environment": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")

const sourceGocardlessResource = new airbyte.SourceGocardless("sourceGocardlessResource", {
    configuration: {
        accessToken: "string",
        gocardlessVersion: "string",
        startDate: "string",
        gocardlessEnvironment: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});

type: airbyte:SourceGocardless
properties:
    configuration:
        accessToken: string
        gocardlessEnvironment: string
        gocardlessVersion: string
        startDate: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string

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

Configuration SourceGocardlessConfiguration
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 SourceGocardlessConfigurationArgs
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 SourceGocardlessConfiguration
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 SourceGocardlessConfiguration
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 SourceGocardlessConfigurationArgs
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 SourceGocardless 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 SourceGocardless Resource

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

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

func GetSourceGocardless(ctx *Context, name string, id IDInput, state *SourceGocardlessState, opts ...ResourceOption) (*SourceGocardless, error)

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

public static SourceGocardless get(String name, Output<String> id, SourceGocardlessState state, CustomResourceOptions options)

resources:  _:    type: airbyte:SourceGocardless    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 SourceGocardlessConfiguration
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 SourceGocardlessConfigurationArgs
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 SourceGocardlessConfiguration
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 SourceGocardlessConfiguration
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 SourceGocardlessConfigurationArgs
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

SourceGocardlessConfiguration, SourceGocardlessConfigurationArgs

AccessToken string: Gocardless API TOKEN
GocardlessVersion string: GoCardless version. This is a date. You can find the latest here: https://developer.gocardless.com/api-reference/#api-usage-making-requests
StartDate string: UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated.
GocardlessEnvironment string: Environment you are trying to connect to. Default: "sandbox"; must be one of ["sandbox", "live"]

AccessToken string: Gocardless API TOKEN
GocardlessVersion string: GoCardless version. This is a date. You can find the latest here: https://developer.gocardless.com/api-reference/#api-usage-making-requests
StartDate string: UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated.
GocardlessEnvironment string: Environment you are trying to connect to. Default: "sandbox"; must be one of ["sandbox", "live"]

accessToken String: Gocardless API TOKEN
gocardlessVersion String: GoCardless version. This is a date. You can find the latest here: https://developer.gocardless.com/api-reference/#api-usage-making-requests
startDate String: UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated.
gocardlessEnvironment String: Environment you are trying to connect to. Default: "sandbox"; must be one of ["sandbox", "live"]

accessToken string: Gocardless API TOKEN
gocardlessVersion string: GoCardless version. This is a date. You can find the latest here: https://developer.gocardless.com/api-reference/#api-usage-making-requests
startDate string: UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated.
gocardlessEnvironment string: Environment you are trying to connect to. Default: "sandbox"; must be one of ["sandbox", "live"]

access_token str: Gocardless API TOKEN
gocardless_version str: GoCardless version. This is a date. You can find the latest here: https://developer.gocardless.com/api-reference/#api-usage-making-requests
start_date str: UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated.
gocardless_environment str: Environment you are trying to connect to. Default: "sandbox"; must be one of ["sandbox", "live"]

accessToken String: Gocardless API TOKEN
gocardlessVersion String: GoCardless version. This is a date. You can find the latest here: https://developer.gocardless.com/api-reference/#api-usage-making-requests
startDate String: UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated.
gocardlessEnvironment String: Environment you are trying to connect to. Default: "sandbox"; must be one of ["sandbox", "live"]

Import

$ pulumi import airbyte:index/sourceGocardless:SourceGocardless my_airbyte_source_gocardless ""

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.SourceGocardless

On this page

On this page

Example Usage

Create SourceGocardless Resource

Constructor syntax

Parameters

Constructor example

SourceGocardless Resource Properties

Inputs

Outputs

Look up Existing SourceGocardless Resource

Supporting Types

SourceGocardlessConfiguration, SourceGocardlessConfigurationArgs

Import

Package Details

On this page

On this page