ConnectionConfig

fivetran 1.9.29, Mar 31 26

Viewing docs for fivetran 1.9.29
published on Tuesday, Mar 31, 2026 by fivetran

Schema (JSON)

fivetran/terraform-provider-fivetran

Viewing docs for fivetran 1.9.29
published on Tuesday, Mar 31, 2026 by fivetran

Schema (JSON)

fivetran/terraform-provider-fivetran

Import

Connection configurations can be imported using the connection ID:

$ pulumi import fivetran:index/connectionConfig:ConnectionConfig example connection_id_here

Create ConnectionConfig Resource

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

Constructor syntax

new ConnectionConfig(name: string, args: ConnectionConfigArgs, opts?: CustomResourceOptions);

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

@overload
def ConnectionConfig(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     connection_id: Optional[str] = None,
                     auth: Optional[str] = None,
                     config: Optional[str] = None,
                     run_setup_tests: Optional[bool] = None,
                     trust_certificates: Optional[bool] = None,
                     trust_fingerprints: Optional[bool] = None)

func NewConnectionConfig(ctx *Context, name string, args ConnectionConfigArgs, opts ...ResourceOption) (*ConnectionConfig, error)

public ConnectionConfig(string name, ConnectionConfigArgs args, CustomResourceOptions? opts = null)

public ConnectionConfig(String name, ConnectionConfigArgs args)
public ConnectionConfig(String name, ConnectionConfigArgs args, CustomResourceOptions options)

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

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

name String: The unique name of the resource.
args ConnectionConfigArgs: 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 connectionConfigResource = new Fivetran.Index.ConnectionConfig("connectionConfigResource", new()
{
    ConnectionId = "string",
    Auth = "string",
    Config = "string",
    RunSetupTests = false,
    TrustCertificates = false,
    TrustFingerprints = false,
});

example, err := fivetran.NewConnectionConfig(ctx, "connectionConfigResource", &fivetran.ConnectionConfigArgs{
	ConnectionId:      pulumi.String("string"),
	Auth:              pulumi.String("string"),
	Config:            pulumi.String("string"),
	RunSetupTests:     pulumi.Bool(false),
	TrustCertificates: pulumi.Bool(false),
	TrustFingerprints: pulumi.Bool(false),
})

var connectionConfigResource = new ConnectionConfig("connectionConfigResource", ConnectionConfigArgs.builder()
    .connectionId("string")
    .auth("string")
    .config("string")
    .runSetupTests(false)
    .trustCertificates(false)
    .trustFingerprints(false)
    .build());

connection_config_resource = fivetran.ConnectionConfig("connectionConfigResource",
    connection_id="string",
    auth="string",
    config="string",
    run_setup_tests=False,
    trust_certificates=False,
    trust_fingerprints=False)

const connectionConfigResource = new fivetran.ConnectionConfig("connectionConfigResource", {
    connectionId: "string",
    auth: "string",
    config: "string",
    runSetupTests: false,
    trustCertificates: false,
    trustFingerprints: false,
});

type: fivetran:ConnectionConfig
properties:
    auth: string
    config: string
    connectionId: string
    runSetupTests: false
    trustCertificates: false
    trustFingerprints: false

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

ConnectionId string: The unique identifier for the connection within the Fivetran system.
Auth string: Connection auth config in Json format, following Fivetran API endpoint contract for auth field. This field uses semantic JSON equality, so whitespace and key order differences won't trigger updates.
Config string: Connection config in Json format, following Fivetran API endpoint contract for config field. This field uses semantic JSON equality, so whitespace and key order differences won't trigger updates.
RunSetupTests bool: Whether to run setup tests when applying configuration. Default: false. When true, Fivetran validates the configuration by testing the connection. Note: This is a plan-only attribute and will not be stored in state.
TrustCertificates bool: Whether to automatically trust SSL certificates. Default: false. Note: This is a plan-only attribute and will not be stored in state.
TrustFingerprints bool: Whether to automatically trust SSH fingerprints. Default: false. Note: This is a plan-only attribute and will not be stored in state.

ConnectionId string: The unique identifier for the connection within the Fivetran system.
Auth string: Connection auth config in Json format, following Fivetran API endpoint contract for auth field. This field uses semantic JSON equality, so whitespace and key order differences won't trigger updates.
Config string: Connection config in Json format, following Fivetran API endpoint contract for config field. This field uses semantic JSON equality, so whitespace and key order differences won't trigger updates.
RunSetupTests bool: Whether to run setup tests when applying configuration. Default: false. When true, Fivetran validates the configuration by testing the connection. Note: This is a plan-only attribute and will not be stored in state.
TrustCertificates bool: Whether to automatically trust SSL certificates. Default: false. Note: This is a plan-only attribute and will not be stored in state.
TrustFingerprints bool: Whether to automatically trust SSH fingerprints. Default: false. Note: This is a plan-only attribute and will not be stored in state.

connectionId String: The unique identifier for the connection within the Fivetran system.
auth String: Connection auth config in Json format, following Fivetran API endpoint contract for auth field. This field uses semantic JSON equality, so whitespace and key order differences won't trigger updates.
config String: Connection config in Json format, following Fivetran API endpoint contract for config field. This field uses semantic JSON equality, so whitespace and key order differences won't trigger updates.
runSetupTests Boolean: Whether to run setup tests when applying configuration. Default: false. When true, Fivetran validates the configuration by testing the connection. Note: This is a plan-only attribute and will not be stored in state.
trustCertificates Boolean: Whether to automatically trust SSL certificates. Default: false. Note: This is a plan-only attribute and will not be stored in state.
trustFingerprints Boolean: Whether to automatically trust SSH fingerprints. Default: false. Note: This is a plan-only attribute and will not be stored in state.

connectionId string: The unique identifier for the connection within the Fivetran system.
auth string: Connection auth config in Json format, following Fivetran API endpoint contract for auth field. This field uses semantic JSON equality, so whitespace and key order differences won't trigger updates.
config string: Connection config in Json format, following Fivetran API endpoint contract for config field. This field uses semantic JSON equality, so whitespace and key order differences won't trigger updates.
runSetupTests boolean: Whether to run setup tests when applying configuration. Default: false. When true, Fivetran validates the configuration by testing the connection. Note: This is a plan-only attribute and will not be stored in state.
trustCertificates boolean: Whether to automatically trust SSL certificates. Default: false. Note: This is a plan-only attribute and will not be stored in state.
trustFingerprints boolean: Whether to automatically trust SSH fingerprints. Default: false. Note: This is a plan-only attribute and will not be stored in state.

connection_id str: The unique identifier for the connection within the Fivetran system.
auth str: Connection auth config in Json format, following Fivetran API endpoint contract for auth field. This field uses semantic JSON equality, so whitespace and key order differences won't trigger updates.
config str: Connection config in Json format, following Fivetran API endpoint contract for config field. This field uses semantic JSON equality, so whitespace and key order differences won't trigger updates.
run_setup_tests bool: Whether to run setup tests when applying configuration. Default: false. When true, Fivetran validates the configuration by testing the connection. Note: This is a plan-only attribute and will not be stored in state.
trust_certificates bool: Whether to automatically trust SSL certificates. Default: false. Note: This is a plan-only attribute and will not be stored in state.
trust_fingerprints bool: Whether to automatically trust SSH fingerprints. Default: false. Note: This is a plan-only attribute and will not be stored in state.

connectionId String: The unique identifier for the connection within the Fivetran system.
auth String: Connection auth config in Json format, following Fivetran API endpoint contract for auth field. This field uses semantic JSON equality, so whitespace and key order differences won't trigger updates.
config String: Connection config in Json format, following Fivetran API endpoint contract for config field. This field uses semantic JSON equality, so whitespace and key order differences won't trigger updates.
runSetupTests Boolean: Whether to run setup tests when applying configuration. Default: false. When true, Fivetran validates the configuration by testing the connection. Note: This is a plan-only attribute and will not be stored in state.
trustCertificates Boolean: Whether to automatically trust SSL certificates. Default: false. Note: This is a plan-only attribute and will not be stored in state.
trustFingerprints Boolean: Whether to automatically trust SSH fingerprints. Default: false. Note: This is a plan-only attribute and will not be stored in state.

Outputs

All input properties are implicitly available as output properties. Additionally, the ConnectionConfig 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 ConnectionConfig Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auth: Optional[str] = None,
        config: Optional[str] = None,
        connection_id: Optional[str] = None,
        run_setup_tests: Optional[bool] = None,
        trust_certificates: Optional[bool] = None,
        trust_fingerprints: Optional[bool] = None) -> ConnectionConfig

func GetConnectionConfig(ctx *Context, name string, id IDInput, state *ConnectionConfigState, opts ...ResourceOption) (*ConnectionConfig, error)

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

public static ConnectionConfig get(String name, Output<String> id, ConnectionConfigState state, CustomResourceOptions options)

resources:  _:    type: fivetran:ConnectionConfig    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:

Auth string: Connection auth config in Json format, following Fivetran API endpoint contract for auth field. This field uses semantic JSON equality, so whitespace and key order differences won't trigger updates.
Config string: Connection config in Json format, following Fivetran API endpoint contract for config field. This field uses semantic JSON equality, so whitespace and key order differences won't trigger updates.
ConnectionId string: The unique identifier for the connection within the Fivetran system.
RunSetupTests bool: Whether to run setup tests when applying configuration. Default: false. When true, Fivetran validates the configuration by testing the connection. Note: This is a plan-only attribute and will not be stored in state.
TrustCertificates bool: Whether to automatically trust SSL certificates. Default: false. Note: This is a plan-only attribute and will not be stored in state.
TrustFingerprints bool: Whether to automatically trust SSH fingerprints. Default: false. Note: This is a plan-only attribute and will not be stored in state.

Auth string: Connection auth config in Json format, following Fivetran API endpoint contract for auth field. This field uses semantic JSON equality, so whitespace and key order differences won't trigger updates.
Config string: Connection config in Json format, following Fivetran API endpoint contract for config field. This field uses semantic JSON equality, so whitespace and key order differences won't trigger updates.
ConnectionId string: The unique identifier for the connection within the Fivetran system.
RunSetupTests bool: Whether to run setup tests when applying configuration. Default: false. When true, Fivetran validates the configuration by testing the connection. Note: This is a plan-only attribute and will not be stored in state.
TrustCertificates bool: Whether to automatically trust SSL certificates. Default: false. Note: This is a plan-only attribute and will not be stored in state.
TrustFingerprints bool: Whether to automatically trust SSH fingerprints. Default: false. Note: This is a plan-only attribute and will not be stored in state.

auth String: Connection auth config in Json format, following Fivetran API endpoint contract for auth field. This field uses semantic JSON equality, so whitespace and key order differences won't trigger updates.
config String: Connection config in Json format, following Fivetran API endpoint contract for config field. This field uses semantic JSON equality, so whitespace and key order differences won't trigger updates.
connectionId String: The unique identifier for the connection within the Fivetran system.
runSetupTests Boolean: Whether to run setup tests when applying configuration. Default: false. When true, Fivetran validates the configuration by testing the connection. Note: This is a plan-only attribute and will not be stored in state.
trustCertificates Boolean: Whether to automatically trust SSL certificates. Default: false. Note: This is a plan-only attribute and will not be stored in state.
trustFingerprints Boolean: Whether to automatically trust SSH fingerprints. Default: false. Note: This is a plan-only attribute and will not be stored in state.

auth string: Connection auth config in Json format, following Fivetran API endpoint contract for auth field. This field uses semantic JSON equality, so whitespace and key order differences won't trigger updates.
config string: Connection config in Json format, following Fivetran API endpoint contract for config field. This field uses semantic JSON equality, so whitespace and key order differences won't trigger updates.
connectionId string: The unique identifier for the connection within the Fivetran system.
runSetupTests boolean: Whether to run setup tests when applying configuration. Default: false. When true, Fivetran validates the configuration by testing the connection. Note: This is a plan-only attribute and will not be stored in state.
trustCertificates boolean: Whether to automatically trust SSL certificates. Default: false. Note: This is a plan-only attribute and will not be stored in state.
trustFingerprints boolean: Whether to automatically trust SSH fingerprints. Default: false. Note: This is a plan-only attribute and will not be stored in state.

auth str: Connection auth config in Json format, following Fivetran API endpoint contract for auth field. This field uses semantic JSON equality, so whitespace and key order differences won't trigger updates.
config str: Connection config in Json format, following Fivetran API endpoint contract for config field. This field uses semantic JSON equality, so whitespace and key order differences won't trigger updates.
connection_id str: The unique identifier for the connection within the Fivetran system.
run_setup_tests bool: Whether to run setup tests when applying configuration. Default: false. When true, Fivetran validates the configuration by testing the connection. Note: This is a plan-only attribute and will not be stored in state.
trust_certificates bool: Whether to automatically trust SSL certificates. Default: false. Note: This is a plan-only attribute and will not be stored in state.
trust_fingerprints bool: Whether to automatically trust SSH fingerprints. Default: false. Note: This is a plan-only attribute and will not be stored in state.

auth String: Connection auth config in Json format, following Fivetran API endpoint contract for auth field. This field uses semantic JSON equality, so whitespace and key order differences won't trigger updates.
config String: Connection config in Json format, following Fivetran API endpoint contract for config field. This field uses semantic JSON equality, so whitespace and key order differences won't trigger updates.
connectionId String: The unique identifier for the connection within the Fivetran system.
runSetupTests Boolean: Whether to run setup tests when applying configuration. Default: false. When true, Fivetran validates the configuration by testing the connection. Note: This is a plan-only attribute and will not be stored in state.
trustCertificates Boolean: Whether to automatically trust SSL certificates. Default: false. Note: This is a plan-only attribute and will not be stored in state.
trustFingerprints Boolean: Whether to automatically trust SSH fingerprints. Default: false. Note: This is a plan-only attribute and will not be stored in state.