Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Fivetran Provider
  3. API Docs
  4. ConnectorSchedule
fivetran 1.5.1 published on Friday, Mar 7, 2025 by fivetran
fivetran/terraform-provider-fivetran

fivetran.ConnectorSchedule

Explore with Pulumi AI

fivetran logo
fivetran 1.5.1 published on Friday, Mar 7, 2025 by fivetran
fivetran/terraform-provider-fivetran

    -This resource allows you to manage connectors schedule: pause/unpause connector, set daily_sync_time and sync_frequency.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as fivetran from "@pulumi/fivetran";

const myConnectorSchedule = new fivetran.ConnectorSchedule("myConnectorSchedule", {
    connectorId: fivetran_connector.my_connector.id,
    syncFrequency: "1440",
    dailySyncTime: "03:00",
    paused: "false",
    pauseAfterTrial: "true",
    scheduleType: "auto",
});

    import pulumi
import pulumi_fivetran as fivetran

my_connector_schedule = fivetran.ConnectorSchedule("myConnectorSchedule",
    connector_id=fivetran_connector["my_connector"]["id"],
    sync_frequency="1440",
    daily_sync_time="03:00",
    paused="false",
    pause_after_trial="true",
    schedule_type="auto")

    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.NewConnectorSchedule(ctx, "myConnectorSchedule", &fivetran.ConnectorScheduleArgs{
			ConnectorId:     pulumi.Any(fivetran_connector.My_connector.Id),
			SyncFrequency:   pulumi.String("1440"),
			DailySyncTime:   pulumi.String("03:00"),
			Paused:          pulumi.String("false"),
			PauseAfterTrial: pulumi.String("true"),
			ScheduleType:    pulumi.String("auto"),
		})
		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 myConnectorSchedule = new Fivetran.ConnectorSchedule("myConnectorSchedule", new()
    {
        ConnectorId = fivetran_connector.My_connector.Id,
        SyncFrequency = "1440",
        DailySyncTime = "03:00",
        Paused = "false",
        PauseAfterTrial = "true",
        ScheduleType = "auto",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fivetran.ConnectorSchedule;
import com.pulumi.fivetran.ConnectorScheduleArgs;
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 myConnectorSchedule = new ConnectorSchedule("myConnectorSchedule", ConnectorScheduleArgs.builder()
            .connectorId(fivetran_connector.my_connector().id())
            .syncFrequency("1440")
            .dailySyncTime("03:00")
            .paused(false)
            .pauseAfterTrial(true)
            .scheduleType("auto")
            .build());

    }
}

    resources:
  myConnectorSchedule:
    type: fivetran:ConnectorSchedule
    properties:
      connectorId: ${fivetran_connector.my_connector.id}
      syncFrequency: '1440'
      dailySyncTime: 03:00
      paused: false
      pauseAfterTrial: true
      scheduleType: auto

    Create ConnectorSchedule Resource

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

    Constructor syntax

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

@overload
def ConnectorSchedule(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      connector_id: Optional[str] = None,
                      daily_sync_time: Optional[str] = None,
                      pause_after_trial: Optional[str] = None,
                      paused: Optional[str] = None,
                      schedule_type: Optional[str] = None,
                      sync_frequency: Optional[str] = None)
    func NewConnectorSchedule(ctx *Context, name string, args ConnectorScheduleArgs, opts ...ResourceOption) (*ConnectorSchedule, error)
    public ConnectorSchedule(string name, ConnectorScheduleArgs args, CustomResourceOptions? opts = null)
    public ConnectorSchedule(String name, ConnectorScheduleArgs args)
public ConnectorSchedule(String name, ConnectorScheduleArgs args, CustomResourceOptions options)

    type: fivetran:ConnectorSchedule
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 ConnectorScheduleArgs
    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 ConnectorScheduleArgs
    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 ConnectorScheduleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConnectorScheduleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConnectorScheduleArgs
    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 connectorScheduleResource = new Fivetran.ConnectorSchedule("connectorScheduleResource", new()
{
    ConnectorId = "string",
    DailySyncTime = "string",
    PauseAfterTrial = "string",
    Paused = "string",
    ScheduleType = "string",
    SyncFrequency = "string",
});

    example, err := fivetran.NewConnectorSchedule(ctx, "connectorScheduleResource", &fivetran.ConnectorScheduleArgs{
ConnectorId: pulumi.String("string"),
DailySyncTime: pulumi.String("string"),
PauseAfterTrial: pulumi.String("string"),
Paused: pulumi.String("string"),
ScheduleType: pulumi.String("string"),
SyncFrequency: pulumi.String("string"),
})

    var connectorScheduleResource = new ConnectorSchedule("connectorScheduleResource", ConnectorScheduleArgs.builder()
    .connectorId("string")
    .dailySyncTime("string")
    .pauseAfterTrial("string")
    .paused("string")
    .scheduleType("string")
    .syncFrequency("string")
    .build());

    connector_schedule_resource = fivetran.ConnectorSchedule("connectorScheduleResource",
    connector_id="string",
    daily_sync_time="string",
    pause_after_trial="string",
    paused="string",
    schedule_type="string",
    sync_frequency="string")

    const connectorScheduleResource = new fivetran.ConnectorSchedule("connectorScheduleResource", {
    connectorId: "string",
    dailySyncTime: "string",
    pauseAfterTrial: "string",
    paused: "string",
    scheduleType: "string",
    syncFrequency: "string",
});

    type: fivetran:ConnectorSchedule
properties:
    connectorId: string
    dailySyncTime: string
    pauseAfterTrial: string
    paused: string
    scheduleType: string
    syncFrequency: string

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

    ConnectorId string
    The unique identifier for the connector within the Fivetran system.
    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.
    PauseAfterTrial string
    Specifies whether the connector should be paused after the free trial period has ended.
    Paused string
    Specifies whether the connector is paused.
    ScheduleType string
    The connector schedule configuration type. Supported values: auto, manual.
    SyncFrequency string
    The connector sync frequency in minutes. Supported values: 1, 5, 15, 30, 60, 120, 180, 360, 480, 720, 1440.
    ConnectorId string
    The unique identifier for the connector within the Fivetran system.
    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.
    PauseAfterTrial string
    Specifies whether the connector should be paused after the free trial period has ended.
    Paused string
    Specifies whether the connector is paused.
    ScheduleType string
    The connector schedule configuration type. Supported values: auto, manual.
    SyncFrequency string
    The connector sync frequency in minutes. Supported values: 1, 5, 15, 30, 60, 120, 180, 360, 480, 720, 1440.
    connectorId String
    The unique identifier for the connector within the Fivetran system.
    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.
    pauseAfterTrial String
    Specifies whether the connector should be paused after the free trial period has ended.
    paused String
    Specifies whether the connector is paused.
    scheduleType String
    The connector schedule configuration type. Supported values: auto, manual.
    syncFrequency String
    The connector sync frequency in minutes. Supported values: 1, 5, 15, 30, 60, 120, 180, 360, 480, 720, 1440.
    connectorId string
    The unique identifier for the connector within the Fivetran system.
    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.
    pauseAfterTrial string
    Specifies whether the connector should be paused after the free trial period has ended.
    paused string
    Specifies whether the connector is paused.
    scheduleType string
    The connector schedule configuration type. Supported values: auto, manual.
    syncFrequency string
    The connector sync frequency in minutes. Supported values: 1, 5, 15, 30, 60, 120, 180, 360, 480, 720, 1440.
    connector_id str
    The unique identifier for the connector within the Fivetran system.
    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.
    pause_after_trial str
    Specifies whether the connector should be paused after the free trial period has ended.
    paused str
    Specifies whether the connector is paused.
    schedule_type str
    The connector schedule configuration type. Supported values: auto, manual.
    sync_frequency str
    The connector sync frequency in minutes. Supported values: 1, 5, 15, 30, 60, 120, 180, 360, 480, 720, 1440.
    connectorId String
    The unique identifier for the connector within the Fivetran system.
    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.
    pauseAfterTrial String
    Specifies whether the connector should be paused after the free trial period has ended.
    paused String
    Specifies whether the connector is paused.
    scheduleType String
    The connector schedule configuration type. Supported values: auto, manual.
    syncFrequency String
    The connector sync frequency in minutes. Supported values: 1, 5, 15, 30, 60, 120, 180, 360, 480, 720, 1440.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ConnectorSchedule resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ConnectorSchedule Resource

    Get an existing ConnectorSchedule 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?: ConnectorScheduleState, opts?: CustomResourceOptions): ConnectorSchedule
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        connector_id: Optional[str] = None,
        daily_sync_time: Optional[str] = None,
        pause_after_trial: Optional[str] = None,
        paused: Optional[str] = None,
        schedule_type: Optional[str] = None,
        sync_frequency: Optional[str] = None) -> ConnectorSchedule
    func GetConnectorSchedule(ctx *Context, name string, id IDInput, state *ConnectorScheduleState, opts ...ResourceOption) (*ConnectorSchedule, error)
    public static ConnectorSchedule Get(string name, Input<string> id, ConnectorScheduleState? state, CustomResourceOptions? opts = null)
    public static ConnectorSchedule get(String name, Output<String> id, ConnectorScheduleState state, CustomResourceOptions options)
    resources:  _:    type: fivetran:ConnectorSchedule    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:
    ConnectorId string
    The unique identifier for the connector within the Fivetran system.
    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.
    PauseAfterTrial string
    Specifies whether the connector should be paused after the free trial period has ended.
    Paused string
    Specifies whether the connector is paused.
    ScheduleType string
    The connector schedule configuration type. Supported values: auto, manual.
    SyncFrequency string
    The connector sync frequency in minutes. Supported values: 1, 5, 15, 30, 60, 120, 180, 360, 480, 720, 1440.
    ConnectorId string
    The unique identifier for the connector within the Fivetran system.
    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.
    PauseAfterTrial string
    Specifies whether the connector should be paused after the free trial period has ended.
    Paused string
    Specifies whether the connector is paused.
    ScheduleType string
    The connector schedule configuration type. Supported values: auto, manual.
    SyncFrequency string
    The connector sync frequency in minutes. Supported values: 1, 5, 15, 30, 60, 120, 180, 360, 480, 720, 1440.
    connectorId String
    The unique identifier for the connector within the Fivetran system.
    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.
    pauseAfterTrial String
    Specifies whether the connector should be paused after the free trial period has ended.
    paused String
    Specifies whether the connector is paused.
    scheduleType String
    The connector schedule configuration type. Supported values: auto, manual.
    syncFrequency String
    The connector sync frequency in minutes. Supported values: 1, 5, 15, 30, 60, 120, 180, 360, 480, 720, 1440.
    connectorId string
    The unique identifier for the connector within the Fivetran system.
    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.
    pauseAfterTrial string
    Specifies whether the connector should be paused after the free trial period has ended.
    paused string
    Specifies whether the connector is paused.
    scheduleType string
    The connector schedule configuration type. Supported values: auto, manual.
    syncFrequency string
    The connector sync frequency in minutes. Supported values: 1, 5, 15, 30, 60, 120, 180, 360, 480, 720, 1440.
    connector_id str
    The unique identifier for the connector within the Fivetran system.
    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.
    pause_after_trial str
    Specifies whether the connector should be paused after the free trial period has ended.
    paused str
    Specifies whether the connector is paused.
    schedule_type str
    The connector schedule configuration type. Supported values: auto, manual.
    sync_frequency str
    The connector sync frequency in minutes. Supported values: 1, 5, 15, 30, 60, 120, 180, 360, 480, 720, 1440.
    connectorId String
    The unique identifier for the connector within the Fivetran system.
    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.
    pauseAfterTrial String
    Specifies whether the connector should be paused after the free trial period has ended.
    paused String
    Specifies whether the connector is paused.
    scheduleType String
    The connector schedule configuration type. Supported values: auto, manual.
    syncFrequency String
    The connector sync frequency in minutes. Supported values: 1, 5, 15, 30, 60, 120, 180, 360, 480, 720, 1440.

    Import

    You don’t need to import this resource as it is synthetic.

    To fetch schedule values from existing connector use fivetran_connector data source:

    hcl

    data “fivetran_connector” “my_connector” {

    id = "my_connector_id"

    }

    now you can use schedule values from this data_source:

    sync_frequency = data.fivetran_connector.my_connector.sync_frequency

    paused = data.fivetran_connector.my_connector.paused

    This resource manages settings for already existing connector instance and doesn’t create a new one.

    If you already have an existing connector with id = my_connector_id just define fivetran_connector_schedule resource:

    hcl

    resource “fivetran_connector_schedule” “my_connector_schedule” {

    connector_id = "my_connector_id"

sync_frequency     = "360"

paused             = false

pause_after_trial  = true

schedule_type      = "auto"

    }

    -> NOTE: You can’t have several resources managing the same connector_id. They will be in conflict ater each apply.

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    fivetran fivetran/terraform-provider-fivetran
    License
    Notes
    This Pulumi package is based on the fivetran Terraform Provider.
    fivetran logo
    fivetran 1.5.1 published on Friday, Mar 7, 2025 by fivetran
    fivetran/terraform-provider-fivetran