Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Fivetran Provider
  3. API Docs
  4. HybridDeploymentAgent
fivetran 1.6.0 published on Tuesday, Mar 25, 2025 by fivetran
fivetran/terraform-provider-fivetran

fivetran.HybridDeploymentAgent

Explore with Pulumi AI

fivetran logo
fivetran 1.6.0 published on Tuesday, Mar 25, 2025 by fivetran
fivetran/terraform-provider-fivetran

    This resource allows you to create, update, and delete hybrid deployment agents.

    Example Usage

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

const hybridDeploymentAgent = new fivetran.HybridDeploymentAgent("hybridDeploymentAgent", {
    displayName: "display_name",
    groupId: "group_id",
    authType: "AUTO",
}, {
    provider: fivetran_provider,
});

    import pulumi
import pulumi_fivetran as fivetran

hybrid_deployment_agent = fivetran.HybridDeploymentAgent("hybridDeploymentAgent",
    display_name="display_name",
    group_id="group_id",
    auth_type="AUTO",
    opts = pulumi.ResourceOptions(provider=fivetran_provider))

    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.NewHybridDeploymentAgent(ctx, "hybridDeploymentAgent", &fivetran.HybridDeploymentAgentArgs{
			DisplayName: pulumi.String("display_name"),
			GroupId:     pulumi.String("group_id"),
			AuthType:    pulumi.String("AUTO"),
		}, pulumi.Provider(fivetran_provider))
		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 hybridDeploymentAgent = new Fivetran.HybridDeploymentAgent("hybridDeploymentAgent", new()
    {
        DisplayName = "display_name",
        GroupId = "group_id",
        AuthType = "AUTO",
    }, new CustomResourceOptions
    {
        Provider = fivetran_provider,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fivetran.HybridDeploymentAgent;
import com.pulumi.fivetran.HybridDeploymentAgentArgs;
import com.pulumi.resources.CustomResourceOptions;
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 hybridDeploymentAgent = new HybridDeploymentAgent("hybridDeploymentAgent", HybridDeploymentAgentArgs.builder()
            .displayName("display_name")
            .groupId("group_id")
            .authType("AUTO")
            .build(), CustomResourceOptions.builder()
                .provider(fivetran_provider)
                .build());

    }
}

    resources:
  hybridDeploymentAgent:
    type: fivetran:HybridDeploymentAgent
    properties:
      displayName: display_name
      groupId: group_id
      authType: AUTO
    options:
      provider: ${["fivetran-provider"]}

    Create HybridDeploymentAgent Resource

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

    Constructor syntax

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

@overload
def HybridDeploymentAgent(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          auth_type: Optional[str] = None,
                          display_name: Optional[str] = None,
                          group_id: Optional[str] = None,
                          authentication_counter: Optional[float] = None)
    func NewHybridDeploymentAgent(ctx *Context, name string, args HybridDeploymentAgentArgs, opts ...ResourceOption) (*HybridDeploymentAgent, error)
    public HybridDeploymentAgent(string name, HybridDeploymentAgentArgs args, CustomResourceOptions? opts = null)
    public HybridDeploymentAgent(String name, HybridDeploymentAgentArgs args)
public HybridDeploymentAgent(String name, HybridDeploymentAgentArgs args, CustomResourceOptions options)

    type: fivetran:HybridDeploymentAgent
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 HybridDeploymentAgentArgs
    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 HybridDeploymentAgentArgs
    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 HybridDeploymentAgentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args HybridDeploymentAgentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args HybridDeploymentAgentArgs
    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 hybridDeploymentAgentResource = new Fivetran.HybridDeploymentAgent("hybridDeploymentAgentResource", new()
{
    AuthType = "string",
    DisplayName = "string",
    GroupId = "string",
    AuthenticationCounter = 0,
});

    example, err := fivetran.NewHybridDeploymentAgent(ctx, "hybridDeploymentAgentResource", &fivetran.HybridDeploymentAgentArgs{
AuthType: pulumi.String("string"),
DisplayName: pulumi.String("string"),
GroupId: pulumi.String("string"),
AuthenticationCounter: pulumi.Float64(0),
})

    var hybridDeploymentAgentResource = new HybridDeploymentAgent("hybridDeploymentAgentResource", HybridDeploymentAgentArgs.builder()
    .authType("string")
    .displayName("string")
    .groupId("string")
    .authenticationCounter(0)
    .build());

    hybrid_deployment_agent_resource = fivetran.HybridDeploymentAgent("hybridDeploymentAgentResource",
    auth_type="string",
    display_name="string",
    group_id="string",
    authentication_counter=0)

    const hybridDeploymentAgentResource = new fivetran.HybridDeploymentAgent("hybridDeploymentAgentResource", {
    authType: "string",
    displayName: "string",
    groupId: "string",
    authenticationCounter: 0,
});

    type: fivetran:HybridDeploymentAgent
properties:
    authType: string
    authenticationCounter: 0
    displayName: string
    groupId: string

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

    AuthType string
    Type of authentification. Possible values AUTO,MANUAL
    DisplayName string
    The unique name for the hybrid deployment agent.
    GroupId string
    The unique identifier for the Group within the Fivetran system.
    AuthenticationCounter double
    Determines whether re-authentication needs to be performed.
    AuthType string
    Type of authentification. Possible values AUTO,MANUAL
    DisplayName string
    The unique name for the hybrid deployment agent.
    GroupId string
    The unique identifier for the Group within the Fivetran system.
    AuthenticationCounter float64
    Determines whether re-authentication needs to be performed.
    authType String
    Type of authentification. Possible values AUTO,MANUAL
    displayName String
    The unique name for the hybrid deployment agent.
    groupId String
    The unique identifier for the Group within the Fivetran system.
    authenticationCounter Double
    Determines whether re-authentication needs to be performed.
    authType string
    Type of authentification. Possible values AUTO,MANUAL
    displayName string
    The unique name for the hybrid deployment agent.
    groupId string
    The unique identifier for the Group within the Fivetran system.
    authenticationCounter number
    Determines whether re-authentication needs to be performed.
    auth_type str
    Type of authentification. Possible values AUTO,MANUAL
    display_name str
    The unique name for the hybrid deployment agent.
    group_id str
    The unique identifier for the Group within the Fivetran system.
    authentication_counter float
    Determines whether re-authentication needs to be performed.
    authType String
    Type of authentification. Possible values AUTO,MANUAL
    displayName String
    The unique name for the hybrid deployment agent.
    groupId String
    The unique identifier for the Group within the Fivetran system.
    authenticationCounter Number
    Determines whether re-authentication needs to be performed.

    Outputs

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

    AuthJson string
    Base64-encoded content of the auth.json file.
    ConfigJson string
    Base64-encoded content of the config.json file.
    DockerComposeYaml string
    Base64-encoded content of the compose file for the chosen containerization type.
    Id string
    The provider-assigned unique ID for this managed resource.
    RegisteredAt string
    The timestamp of the time the hybrid deployment agent was created in your account.
    Token string
    Base64 encoded content of token.
    AuthJson string
    Base64-encoded content of the auth.json file.
    ConfigJson string
    Base64-encoded content of the config.json file.
    DockerComposeYaml string
    Base64-encoded content of the compose file for the chosen containerization type.
    Id string
    The provider-assigned unique ID for this managed resource.
    RegisteredAt string
    The timestamp of the time the hybrid deployment agent was created in your account.
    Token string
    Base64 encoded content of token.
    authJson String
    Base64-encoded content of the auth.json file.
    configJson String
    Base64-encoded content of the config.json file.
    dockerComposeYaml String
    Base64-encoded content of the compose file for the chosen containerization type.
    id String
    The provider-assigned unique ID for this managed resource.
    registeredAt String
    The timestamp of the time the hybrid deployment agent was created in your account.
    token String
    Base64 encoded content of token.
    authJson string
    Base64-encoded content of the auth.json file.
    configJson string
    Base64-encoded content of the config.json file.
    dockerComposeYaml string
    Base64-encoded content of the compose file for the chosen containerization type.
    id string
    The provider-assigned unique ID for this managed resource.
    registeredAt string
    The timestamp of the time the hybrid deployment agent was created in your account.
    token string
    Base64 encoded content of token.
    auth_json str
    Base64-encoded content of the auth.json file.
    config_json str
    Base64-encoded content of the config.json file.
    docker_compose_yaml str
    Base64-encoded content of the compose file for the chosen containerization type.
    id str
    The provider-assigned unique ID for this managed resource.
    registered_at str
    The timestamp of the time the hybrid deployment agent was created in your account.
    token str
    Base64 encoded content of token.
    authJson String
    Base64-encoded content of the auth.json file.
    configJson String
    Base64-encoded content of the config.json file.
    dockerComposeYaml String
    Base64-encoded content of the compose file for the chosen containerization type.
    id String
    The provider-assigned unique ID for this managed resource.
    registeredAt String
    The timestamp of the time the hybrid deployment agent was created in your account.
    token String
    Base64 encoded content of token.

    Look up Existing HybridDeploymentAgent Resource

    Get an existing HybridDeploymentAgent 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?: HybridDeploymentAgentState, opts?: CustomResourceOptions): HybridDeploymentAgent
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auth_json: Optional[str] = None,
        auth_type: Optional[str] = None,
        authentication_counter: Optional[float] = None,
        config_json: Optional[str] = None,
        display_name: Optional[str] = None,
        docker_compose_yaml: Optional[str] = None,
        group_id: Optional[str] = None,
        registered_at: Optional[str] = None,
        token: Optional[str] = None) -> HybridDeploymentAgent
    func GetHybridDeploymentAgent(ctx *Context, name string, id IDInput, state *HybridDeploymentAgentState, opts ...ResourceOption) (*HybridDeploymentAgent, error)
    public static HybridDeploymentAgent Get(string name, Input<string> id, HybridDeploymentAgentState? state, CustomResourceOptions? opts = null)
    public static HybridDeploymentAgent get(String name, Output<String> id, HybridDeploymentAgentState state, CustomResourceOptions options)
    resources:  _:    type: fivetran:HybridDeploymentAgent    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:
    AuthJson string
    Base64-encoded content of the auth.json file.
    AuthType string
    Type of authentification. Possible values AUTO,MANUAL
    AuthenticationCounter double
    Determines whether re-authentication needs to be performed.
    ConfigJson string
    Base64-encoded content of the config.json file.
    DisplayName string
    The unique name for the hybrid deployment agent.
    DockerComposeYaml string
    Base64-encoded content of the compose file for the chosen containerization type.
    GroupId string
    The unique identifier for the Group within the Fivetran system.
    RegisteredAt string
    The timestamp of the time the hybrid deployment agent was created in your account.
    Token string
    Base64 encoded content of token.
    AuthJson string
    Base64-encoded content of the auth.json file.
    AuthType string
    Type of authentification. Possible values AUTO,MANUAL
    AuthenticationCounter float64
    Determines whether re-authentication needs to be performed.
    ConfigJson string
    Base64-encoded content of the config.json file.
    DisplayName string
    The unique name for the hybrid deployment agent.
    DockerComposeYaml string
    Base64-encoded content of the compose file for the chosen containerization type.
    GroupId string
    The unique identifier for the Group within the Fivetran system.
    RegisteredAt string
    The timestamp of the time the hybrid deployment agent was created in your account.
    Token string
    Base64 encoded content of token.
    authJson String
    Base64-encoded content of the auth.json file.
    authType String
    Type of authentification. Possible values AUTO,MANUAL
    authenticationCounter Double
    Determines whether re-authentication needs to be performed.
    configJson String
    Base64-encoded content of the config.json file.
    displayName String
    The unique name for the hybrid deployment agent.
    dockerComposeYaml String
    Base64-encoded content of the compose file for the chosen containerization type.
    groupId String
    The unique identifier for the Group within the Fivetran system.
    registeredAt String
    The timestamp of the time the hybrid deployment agent was created in your account.
    token String
    Base64 encoded content of token.
    authJson string
    Base64-encoded content of the auth.json file.
    authType string
    Type of authentification. Possible values AUTO,MANUAL
    authenticationCounter number
    Determines whether re-authentication needs to be performed.
    configJson string
    Base64-encoded content of the config.json file.
    displayName string
    The unique name for the hybrid deployment agent.
    dockerComposeYaml string
    Base64-encoded content of the compose file for the chosen containerization type.
    groupId string
    The unique identifier for the Group within the Fivetran system.
    registeredAt string
    The timestamp of the time the hybrid deployment agent was created in your account.
    token string
    Base64 encoded content of token.
    auth_json str
    Base64-encoded content of the auth.json file.
    auth_type str
    Type of authentification. Possible values AUTO,MANUAL
    authentication_counter float
    Determines whether re-authentication needs to be performed.
    config_json str
    Base64-encoded content of the config.json file.
    display_name str
    The unique name for the hybrid deployment agent.
    docker_compose_yaml str
    Base64-encoded content of the compose file for the chosen containerization type.
    group_id str
    The unique identifier for the Group within the Fivetran system.
    registered_at str
    The timestamp of the time the hybrid deployment agent was created in your account.
    token str
    Base64 encoded content of token.
    authJson String
    Base64-encoded content of the auth.json file.
    authType String
    Type of authentification. Possible values AUTO,MANUAL
    authenticationCounter Number
    Determines whether re-authentication needs to be performed.
    configJson String
    Base64-encoded content of the config.json file.
    displayName String
    The unique name for the hybrid deployment agent.
    dockerComposeYaml String
    Base64-encoded content of the compose file for the chosen containerization type.
    groupId String
    The unique identifier for the Group within the Fivetran system.
    registeredAt String
    The timestamp of the time the hybrid deployment agent was created in your account.
    token String
    Base64 encoded content of token.

    Package Details

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