1. Packages
  2. Fivetran Provider
  3. API Docs
  4. getGroupConnections
fivetran 1.8.1 published on Wednesday, May 28, 2025 by fivetran

fivetran.getGroupConnections

Explore with Pulumi AI

fivetran logo
fivetran 1.8.1 published on Wednesday, May 28, 2025 by fivetran

    This data source returns a list of information about all connections within a group in your Fivetran account.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as fivetran from "@pulumi/fivetran";
    
    const groupConnections = fivetran.getGroupConnections({
        id: "anonymous_mystery",
        schema: "connection_schema_name",
    });
    
    import pulumi
    import pulumi_fivetran as fivetran
    
    group_connections = fivetran.get_group_connections(id="anonymous_mystery",
        schema="connection_schema_name")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/fivetran/fivetran"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := fivetran.GetGroupConnections(ctx, &fivetran.GetGroupConnectionsArgs{
    			Id:     "anonymous_mystery",
    			Schema: pulumi.StringRef("connection_schema_name"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Fivetran = Pulumi.Fivetran;
    
    return await Deployment.RunAsync(() => 
    {
        var groupConnections = Fivetran.GetGroupConnections.Invoke(new()
        {
            Id = "anonymous_mystery",
            Schema = "connection_schema_name",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.fivetran.FivetranFunctions;
    import com.pulumi.fivetran.inputs.GetGroupConnectionsArgs;
    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) {
            final var groupConnections = FivetranFunctions.getGroupConnections(GetGroupConnectionsArgs.builder()
                .id("anonymous_mystery")
                .schema("connection_schema_name")
                .build());
    
        }
    }
    
    variables:
      groupConnections:
        fn::invoke:
          function: fivetran:getGroupConnections
          arguments:
            id: anonymous_mystery
            schema: connection_schema_name
    

    Using getGroupConnections

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getGroupConnections(args: GetGroupConnectionsArgs, opts?: InvokeOptions): Promise<GetGroupConnectionsResult>
    function getGroupConnectionsOutput(args: GetGroupConnectionsOutputArgs, opts?: InvokeOptions): Output<GetGroupConnectionsResult>
    def get_group_connections(connections: Optional[Sequence[GetGroupConnectionsConnection]] = None,
                              id: Optional[str] = None,
                              schema: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetGroupConnectionsResult
    def get_group_connections_output(connections: Optional[pulumi.Input[Sequence[pulumi.Input[GetGroupConnectionsConnectionArgs]]]] = None,
                              id: Optional[pulumi.Input[str]] = None,
                              schema: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetGroupConnectionsResult]
    func GetGroupConnections(ctx *Context, args *GetGroupConnectionsArgs, opts ...InvokeOption) (*GetGroupConnectionsResult, error)
    func GetGroupConnectionsOutput(ctx *Context, args *GetGroupConnectionsOutputArgs, opts ...InvokeOption) GetGroupConnectionsResultOutput

    > Note: This function is named GetGroupConnections in the Go SDK.

    public static class GetGroupConnections 
    {
        public static Task<GetGroupConnectionsResult> InvokeAsync(GetGroupConnectionsArgs args, InvokeOptions? opts = null)
        public static Output<GetGroupConnectionsResult> Invoke(GetGroupConnectionsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetGroupConnectionsResult> getGroupConnections(GetGroupConnectionsArgs args, InvokeOptions options)
    public static Output<GetGroupConnectionsResult> getGroupConnections(GetGroupConnectionsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: fivetran:index/getGroupConnections:getGroupConnections
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    The ID of this resource.
    Connections List<GetGroupConnectionsConnection>
    Schema string
    Optional filter. When defined, the data source will only contain information for the connection with the specified schema name.
    Id string
    The ID of this resource.
    Connections []GetGroupConnectionsConnection
    Schema string
    Optional filter. When defined, the data source will only contain information for the connection with the specified schema name.
    id String
    The ID of this resource.
    connections List<GetGroupConnectionsConnection>
    schema String
    Optional filter. When defined, the data source will only contain information for the connection with the specified schema name.
    id string
    The ID of this resource.
    connections GetGroupConnectionsConnection[]
    schema string
    Optional filter. When defined, the data source will only contain information for the connection with the specified schema name.
    id str
    The ID of this resource.
    connections Sequence[GetGroupConnectionsConnection]
    schema str
    Optional filter. When defined, the data source will only contain information for the connection with the specified schema name.
    id String
    The ID of this resource.
    connections List<Property Map>
    schema String
    Optional filter. When defined, the data source will only contain information for the connection with the specified schema name.

    getGroupConnections Result

    The following output properties are available:

    Id string
    The ID of this resource.
    Connections List<GetGroupConnectionsConnection>
    Schema string
    Optional filter. When defined, the data source will only contain information for the connection with the specified schema name.
    Id string
    The ID of this resource.
    Connections []GetGroupConnectionsConnection
    Schema string
    Optional filter. When defined, the data source will only contain information for the connection with the specified schema name.
    id String
    The ID of this resource.
    connections List<GetGroupConnectionsConnection>
    schema String
    Optional filter. When defined, the data source will only contain information for the connection with the specified schema name.
    id string
    The ID of this resource.
    connections GetGroupConnectionsConnection[]
    schema string
    Optional filter. When defined, the data source will only contain information for the connection with the specified schema name.
    id str
    The ID of this resource.
    connections Sequence[GetGroupConnectionsConnection]
    schema str
    Optional filter. When defined, the data source will only contain information for the connection with the specified schema name.
    id String
    The ID of this resource.
    connections List<Property Map>
    schema String
    Optional filter. When defined, the data source will only contain information for the connection with the specified schema name.

    Supporting Types

    GetGroupConnectionsConnection

    ConnectedBy string
    The unique identifier of the user who has created the connection in your account
    CreatedAt string
    The timestamp of the time the connection was created in your account
    DailySyncTime string
    The optional parameter that defines the sync start time when the sync frequency is already set or being set by the current request to 1440. It can be specified in one hour increments starting from 00:00 to 23:00. If not specified, we will use the baseline sync start time. This parameter has no effect on the 0 to 60 minutes offset used to determine the actual sync start time
    FailedAt string
    The timestamp of the time the connection sync failed last time
    GroupId string
    The unique identifier for the Group within the Fivetran system.
    Id string
    The unique identifier for the Connector within the Fivetran system.
    ScheduleType string
    The connection schedule configuration type. Supported values: auto, manual
    Schema string
    The name used both as the connection's name within the Fivetran system and as the source schema's name within your destination
    Service string
    The connector type name within the Fivetran system
    ServiceVersion double
    The connector type version within the Fivetran system
    SucceededAt string
    The timestamp of the time the connection sync succeeded last time
    SyncFrequency double
    The connection sync frequency in minutes
    Status GetGroupConnectionsConnectionStatus
    ConnectedBy string
    The unique identifier of the user who has created the connection in your account
    CreatedAt string
    The timestamp of the time the connection was created in your account
    DailySyncTime string
    The optional parameter that defines the sync start time when the sync frequency is already set or being set by the current request to 1440. It can be specified in one hour increments starting from 00:00 to 23:00. If not specified, we will use the baseline sync start time. This parameter has no effect on the 0 to 60 minutes offset used to determine the actual sync start time
    FailedAt string
    The timestamp of the time the connection sync failed last time
    GroupId string
    The unique identifier for the Group within the Fivetran system.
    Id string
    The unique identifier for the Connector within the Fivetran system.
    ScheduleType string
    The connection schedule configuration type. Supported values: auto, manual
    Schema string
    The name used both as the connection's name within the Fivetran system and as the source schema's name within your destination
    Service string
    The connector type name within the Fivetran system
    ServiceVersion float64
    The connector type version within the Fivetran system
    SucceededAt string
    The timestamp of the time the connection sync succeeded last time
    SyncFrequency float64
    The connection sync frequency in minutes
    Status GetGroupConnectionsConnectionStatus
    connectedBy String
    The unique identifier of the user who has created the connection in your account
    createdAt String
    The timestamp of the time the connection was created in your account
    dailySyncTime String
    The optional parameter that defines the sync start time when the sync frequency is already set or being set by the current request to 1440. It can be specified in one hour increments starting from 00:00 to 23:00. If not specified, we will use the baseline sync start time. This parameter has no effect on the 0 to 60 minutes offset used to determine the actual sync start time
    failedAt String
    The timestamp of the time the connection sync failed last time
    groupId String
    The unique identifier for the Group within the Fivetran system.
    id String
    The unique identifier for the Connector within the Fivetran system.
    scheduleType String
    The connection schedule configuration type. Supported values: auto, manual
    schema String
    The name used both as the connection's name within the Fivetran system and as the source schema's name within your destination
    service String
    The connector type name within the Fivetran system
    serviceVersion Double
    The connector type version within the Fivetran system
    succeededAt String
    The timestamp of the time the connection sync succeeded last time
    syncFrequency Double
    The connection sync frequency in minutes
    status GetGroupConnectionsConnectionStatus
    connectedBy string
    The unique identifier of the user who has created the connection in your account
    createdAt string
    The timestamp of the time the connection was created in your account
    dailySyncTime string
    The optional parameter that defines the sync start time when the sync frequency is already set or being set by the current request to 1440. It can be specified in one hour increments starting from 00:00 to 23:00. If not specified, we will use the baseline sync start time. This parameter has no effect on the 0 to 60 minutes offset used to determine the actual sync start time
    failedAt string
    The timestamp of the time the connection sync failed last time
    groupId string
    The unique identifier for the Group within the Fivetran system.
    id string
    The unique identifier for the Connector within the Fivetran system.
    scheduleType string
    The connection schedule configuration type. Supported values: auto, manual
    schema string
    The name used both as the connection's name within the Fivetran system and as the source schema's name within your destination
    service string
    The connector type name within the Fivetran system
    serviceVersion number
    The connector type version within the Fivetran system
    succeededAt string
    The timestamp of the time the connection sync succeeded last time
    syncFrequency number
    The connection sync frequency in minutes
    status GetGroupConnectionsConnectionStatus
    connected_by str
    The unique identifier of the user who has created the connection in your account
    created_at str
    The timestamp of the time the connection was created in your account
    daily_sync_time str
    The optional parameter that defines the sync start time when the sync frequency is already set or being set by the current request to 1440. It can be specified in one hour increments starting from 00:00 to 23:00. If not specified, we will use the baseline sync start time. This parameter has no effect on the 0 to 60 minutes offset used to determine the actual sync start time
    failed_at str
    The timestamp of the time the connection sync failed last time
    group_id str
    The unique identifier for the Group within the Fivetran system.
    id str
    The unique identifier for the Connector within the Fivetran system.
    schedule_type str
    The connection schedule configuration type. Supported values: auto, manual
    schema str
    The name used both as the connection's name within the Fivetran system and as the source schema's name within your destination
    service str
    The connector type name within the Fivetran system
    service_version float
    The connector type version within the Fivetran system
    succeeded_at str
    The timestamp of the time the connection sync succeeded last time
    sync_frequency float
    The connection sync frequency in minutes
    status GetGroupConnectionsConnectionStatus
    connectedBy String
    The unique identifier of the user who has created the connection in your account
    createdAt String
    The timestamp of the time the connection was created in your account
    dailySyncTime String
    The optional parameter that defines the sync start time when the sync frequency is already set or being set by the current request to 1440. It can be specified in one hour increments starting from 00:00 to 23:00. If not specified, we will use the baseline sync start time. This parameter has no effect on the 0 to 60 minutes offset used to determine the actual sync start time
    failedAt String
    The timestamp of the time the connection sync failed last time
    groupId String
    The unique identifier for the Group within the Fivetran system.
    id String
    The unique identifier for the Connector within the Fivetran system.
    scheduleType String
    The connection schedule configuration type. Supported values: auto, manual
    schema String
    The name used both as the connection's name within the Fivetran system and as the source schema's name within your destination
    service String
    The connector type name within the Fivetran system
    serviceVersion Number
    The connector type version within the Fivetran system
    succeededAt String
    The timestamp of the time the connection sync succeeded last time
    syncFrequency Number
    The connection sync frequency in minutes
    status Property Map

    GetGroupConnectionsConnectionStatus

    IsHistoricalSync bool
    The boolean specifying whether the connection should be triggered to re-sync all historical data. If you set this parameter to TRUE, the next scheduled sync will be historical. If the value is FALSE or not specified, the connection will not re-sync historical data. NOTE: When the value is TRUE, only the next scheduled sync will be historical, all subsequent ones will be incremental. This parameter is set to FALSE once the historical sync is completed.
    SetupState string
    The current setup state of the connection. The available values are: \n\n - incomplete - the setup config is incomplete, the setup tests never succeeded \n\n - connected - the connection is properly set up \n\n - broken - the connection setup config is broken.
    SyncState string
    The current sync state of the connection. The available values are: \n\n - scheduled - the sync is waiting to be run \n\n - syncing - the sync is currently running \n\n - paused - the sync is currently paused \n\n - rescheduled - the sync is waiting until more API calls are available in the source service.
    UpdateState string
    The current data update state of the connection. The available values are: \n\n - on_schedule - the sync is running smoothly, no delays \n\n - delayed - the data is delayed for a longer time than expected for the update.
    Tasks List<GetGroupConnectionsConnectionStatusTask>
    The collection of tasks for the connection
    Warnings List<GetGroupConnectionsConnectionStatusWarning>
    The collection of warnings for the connection.
    IsHistoricalSync bool
    The boolean specifying whether the connection should be triggered to re-sync all historical data. If you set this parameter to TRUE, the next scheduled sync will be historical. If the value is FALSE or not specified, the connection will not re-sync historical data. NOTE: When the value is TRUE, only the next scheduled sync will be historical, all subsequent ones will be incremental. This parameter is set to FALSE once the historical sync is completed.
    SetupState string
    The current setup state of the connection. The available values are: \n\n - incomplete - the setup config is incomplete, the setup tests never succeeded \n\n - connected - the connection is properly set up \n\n - broken - the connection setup config is broken.
    SyncState string
    The current sync state of the connection. The available values are: \n\n - scheduled - the sync is waiting to be run \n\n - syncing - the sync is currently running \n\n - paused - the sync is currently paused \n\n - rescheduled - the sync is waiting until more API calls are available in the source service.
    UpdateState string
    The current data update state of the connection. The available values are: \n\n - on_schedule - the sync is running smoothly, no delays \n\n - delayed - the data is delayed for a longer time than expected for the update.
    Tasks []GetGroupConnectionsConnectionStatusTask
    The collection of tasks for the connection
    Warnings []GetGroupConnectionsConnectionStatusWarning
    The collection of warnings for the connection.
    isHistoricalSync Boolean
    The boolean specifying whether the connection should be triggered to re-sync all historical data. If you set this parameter to TRUE, the next scheduled sync will be historical. If the value is FALSE or not specified, the connection will not re-sync historical data. NOTE: When the value is TRUE, only the next scheduled sync will be historical, all subsequent ones will be incremental. This parameter is set to FALSE once the historical sync is completed.
    setupState String
    The current setup state of the connection. The available values are: \n\n - incomplete - the setup config is incomplete, the setup tests never succeeded \n\n - connected - the connection is properly set up \n\n - broken - the connection setup config is broken.
    syncState String
    The current sync state of the connection. The available values are: \n\n - scheduled - the sync is waiting to be run \n\n - syncing - the sync is currently running \n\n - paused - the sync is currently paused \n\n - rescheduled - the sync is waiting until more API calls are available in the source service.
    updateState String
    The current data update state of the connection. The available values are: \n\n - on_schedule - the sync is running smoothly, no delays \n\n - delayed - the data is delayed for a longer time than expected for the update.
    tasks List<GetGroupConnectionsConnectionStatusTask>
    The collection of tasks for the connection
    warnings List<GetGroupConnectionsConnectionStatusWarning>
    The collection of warnings for the connection.
    isHistoricalSync boolean
    The boolean specifying whether the connection should be triggered to re-sync all historical data. If you set this parameter to TRUE, the next scheduled sync will be historical. If the value is FALSE or not specified, the connection will not re-sync historical data. NOTE: When the value is TRUE, only the next scheduled sync will be historical, all subsequent ones will be incremental. This parameter is set to FALSE once the historical sync is completed.
    setupState string
    The current setup state of the connection. The available values are: \n\n - incomplete - the setup config is incomplete, the setup tests never succeeded \n\n - connected - the connection is properly set up \n\n - broken - the connection setup config is broken.
    syncState string
    The current sync state of the connection. The available values are: \n\n - scheduled - the sync is waiting to be run \n\n - syncing - the sync is currently running \n\n - paused - the sync is currently paused \n\n - rescheduled - the sync is waiting until more API calls are available in the source service.
    updateState string
    The current data update state of the connection. The available values are: \n\n - on_schedule - the sync is running smoothly, no delays \n\n - delayed - the data is delayed for a longer time than expected for the update.
    tasks GetGroupConnectionsConnectionStatusTask[]
    The collection of tasks for the connection
    warnings GetGroupConnectionsConnectionStatusWarning[]
    The collection of warnings for the connection.
    is_historical_sync bool
    The boolean specifying whether the connection should be triggered to re-sync all historical data. If you set this parameter to TRUE, the next scheduled sync will be historical. If the value is FALSE or not specified, the connection will not re-sync historical data. NOTE: When the value is TRUE, only the next scheduled sync will be historical, all subsequent ones will be incremental. This parameter is set to FALSE once the historical sync is completed.
    setup_state str
    The current setup state of the connection. The available values are: \n\n - incomplete - the setup config is incomplete, the setup tests never succeeded \n\n - connected - the connection is properly set up \n\n - broken - the connection setup config is broken.
    sync_state str
    The current sync state of the connection. The available values are: \n\n - scheduled - the sync is waiting to be run \n\n - syncing - the sync is currently running \n\n - paused - the sync is currently paused \n\n - rescheduled - the sync is waiting until more API calls are available in the source service.
    update_state str
    The current data update state of the connection. The available values are: \n\n - on_schedule - the sync is running smoothly, no delays \n\n - delayed - the data is delayed for a longer time than expected for the update.
    tasks Sequence[GetGroupConnectionsConnectionStatusTask]
    The collection of tasks for the connection
    warnings Sequence[GetGroupConnectionsConnectionStatusWarning]
    The collection of warnings for the connection.
    isHistoricalSync Boolean
    The boolean specifying whether the connection should be triggered to re-sync all historical data. If you set this parameter to TRUE, the next scheduled sync will be historical. If the value is FALSE or not specified, the connection will not re-sync historical data. NOTE: When the value is TRUE, only the next scheduled sync will be historical, all subsequent ones will be incremental. This parameter is set to FALSE once the historical sync is completed.
    setupState String
    The current setup state of the connection. The available values are: \n\n - incomplete - the setup config is incomplete, the setup tests never succeeded \n\n - connected - the connection is properly set up \n\n - broken - the connection setup config is broken.
    syncState String
    The current sync state of the connection. The available values are: \n\n - scheduled - the sync is waiting to be run \n\n - syncing - the sync is currently running \n\n - paused - the sync is currently paused \n\n - rescheduled - the sync is waiting until more API calls are available in the source service.
    updateState String
    The current data update state of the connection. The available values are: \n\n - on_schedule - the sync is running smoothly, no delays \n\n - delayed - the data is delayed for a longer time than expected for the update.
    tasks List<Property Map>
    The collection of tasks for the connection
    warnings List<Property Map>
    The collection of warnings for the connection.

    GetGroupConnectionsConnectionStatusTask

    Code string
    Response status code
    Message string
    Response status text
    Code string
    Response status code
    Message string
    Response status text
    code String
    Response status code
    message String
    Response status text
    code string
    Response status code
    message string
    Response status text
    code str
    Response status code
    message str
    Response status text
    code String
    Response status code
    message String
    Response status text

    GetGroupConnectionsConnectionStatusWarning

    Code string
    Response status code
    Message string
    Response status text
    Code string
    Response status code
    Message string
    Response status text
    code String
    Response status code
    message String
    Response status text
    code string
    Response status code
    message string
    Response status text
    code str
    Response status code
    message str
    Response status text
    code String
    Response status code
    message String
    Response status text

    Package Details

    Repository
    fivetran fivetran/terraform-provider-fivetran
    License
    Notes
    This Pulumi package is based on the fivetran Terraform Provider.
    fivetran logo
    fivetran 1.8.1 published on Wednesday, May 28, 2025 by fivetran