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

fivetran.ProxyAgent

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 proxy agent.

    Example Usage

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

const testProxyAgent = new fivetran.ProxyAgent("testProxyAgent", {
    displayName: "display_name",
    groupRegion: "group_region",
}, {
    provider: fivetran_provider,
});

    import pulumi
import pulumi_fivetran as fivetran

test_proxy_agent = fivetran.ProxyAgent("testProxyAgent",
    display_name="display_name",
    group_region="group_region",
    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.NewProxyAgent(ctx, "testProxyAgent", &fivetran.ProxyAgentArgs{
			DisplayName: pulumi.String("display_name"),
			GroupRegion: pulumi.String("group_region"),
		}, 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 testProxyAgent = new Fivetran.ProxyAgent("testProxyAgent", new()
    {
        DisplayName = "display_name",
        GroupRegion = "group_region",
    }, 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.ProxyAgent;
import com.pulumi.fivetran.ProxyAgentArgs;
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 testProxyAgent = new ProxyAgent("testProxyAgent", ProxyAgentArgs.builder()
            .displayName("display_name")
            .groupRegion("group_region")
            .build(), CustomResourceOptions.builder()
                .provider(fivetran_provider)
                .build());

    }
}

    resources:
  testProxyAgent:
    type: fivetran:ProxyAgent
    properties:
      displayName: display_name
      groupRegion: group_region
    options:
      provider: ${["fivetran-provider"]}

    Create ProxyAgent Resource

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

    Constructor syntax

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

@overload
def ProxyAgent(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               display_name: Optional[str] = None,
               group_region: Optional[str] = None)
    func NewProxyAgent(ctx *Context, name string, args ProxyAgentArgs, opts ...ResourceOption) (*ProxyAgent, error)
    public ProxyAgent(string name, ProxyAgentArgs args, CustomResourceOptions? opts = null)
    public ProxyAgent(String name, ProxyAgentArgs args)
public ProxyAgent(String name, ProxyAgentArgs args, CustomResourceOptions options)

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

    example, err := fivetran.NewProxyAgent(ctx, "proxyAgentResource", &fivetran.ProxyAgentArgs{
DisplayName: pulumi.String("string"),
GroupRegion: pulumi.String("string"),
})

    var proxyAgentResource = new ProxyAgent("proxyAgentResource", ProxyAgentArgs.builder()
    .displayName("string")
    .groupRegion("string")
    .build());

    proxy_agent_resource = fivetran.ProxyAgent("proxyAgentResource",
    display_name="string",
    group_region="string")

    const proxyAgentResource = new fivetran.ProxyAgent("proxyAgentResource", {
    displayName: "string",
    groupRegion: "string",
});

    type: fivetran:ProxyAgent
properties:
    displayName: string
    groupRegion: string

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

    DisplayName string
    Proxy agent name.
    GroupRegion string
    Data processing location. This is where Fivetran will operate and run computation on data.
    DisplayName string
    Proxy agent name.
    GroupRegion string
    Data processing location. This is where Fivetran will operate and run computation on data.
    displayName String
    Proxy agent name.
    groupRegion String
    Data processing location. This is where Fivetran will operate and run computation on data.
    displayName string
    Proxy agent name.
    groupRegion string
    Data processing location. This is where Fivetran will operate and run computation on data.
    display_name str
    Proxy agent name.
    group_region str
    Data processing location. This is where Fivetran will operate and run computation on data.
    displayName String
    Proxy agent name.
    groupRegion String
    Data processing location. This is where Fivetran will operate and run computation on data.

    Outputs

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

    CreatedBy string
    The actor who created the proxy agent.
    Id string
    The provider-assigned unique ID for this managed resource.
    ProxyServerUri string
    The proxy server URI.
    RegistredAt string
    The timestamp of the time the proxy agent was created in your account.
    Salt string
    The salt.
    Token string
    The auth token.
    CreatedBy string
    The actor who created the proxy agent.
    Id string
    The provider-assigned unique ID for this managed resource.
    ProxyServerUri string
    The proxy server URI.
    RegistredAt string
    The timestamp of the time the proxy agent was created in your account.
    Salt string
    The salt.
    Token string
    The auth token.
    createdBy String
    The actor who created the proxy agent.
    id String
    The provider-assigned unique ID for this managed resource.
    proxyServerUri String
    The proxy server URI.
    registredAt String
    The timestamp of the time the proxy agent was created in your account.
    salt String
    The salt.
    token String
    The auth token.
    createdBy string
    The actor who created the proxy agent.
    id string
    The provider-assigned unique ID for this managed resource.
    proxyServerUri string
    The proxy server URI.
    registredAt string
    The timestamp of the time the proxy agent was created in your account.
    salt string
    The salt.
    token string
    The auth token.
    created_by str
    The actor who created the proxy agent.
    id str
    The provider-assigned unique ID for this managed resource.
    proxy_server_uri str
    The proxy server URI.
    registred_at str
    The timestamp of the time the proxy agent was created in your account.
    salt str
    The salt.
    token str
    The auth token.
    createdBy String
    The actor who created the proxy agent.
    id String
    The provider-assigned unique ID for this managed resource.
    proxyServerUri String
    The proxy server URI.
    registredAt String
    The timestamp of the time the proxy agent was created in your account.
    salt String
    The salt.
    token String
    The auth token.

    Look up Existing ProxyAgent Resource

    Get an existing ProxyAgent 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?: ProxyAgentState, opts?: CustomResourceOptions): ProxyAgent
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_by: Optional[str] = None,
        display_name: Optional[str] = None,
        group_region: Optional[str] = None,
        proxy_server_uri: Optional[str] = None,
        registred_at: Optional[str] = None,
        salt: Optional[str] = None,
        token: Optional[str] = None) -> ProxyAgent
    func GetProxyAgent(ctx *Context, name string, id IDInput, state *ProxyAgentState, opts ...ResourceOption) (*ProxyAgent, error)
    public static ProxyAgent Get(string name, Input<string> id, ProxyAgentState? state, CustomResourceOptions? opts = null)
    public static ProxyAgent get(String name, Output<String> id, ProxyAgentState state, CustomResourceOptions options)
    resources:  _:    type: fivetran:ProxyAgent    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:
    CreatedBy string
    The actor who created the proxy agent.
    DisplayName string
    Proxy agent name.
    GroupRegion string
    Data processing location. This is where Fivetran will operate and run computation on data.
    ProxyServerUri string
    The proxy server URI.
    RegistredAt string
    The timestamp of the time the proxy agent was created in your account.
    Salt string
    The salt.
    Token string
    The auth token.
    CreatedBy string
    The actor who created the proxy agent.
    DisplayName string
    Proxy agent name.
    GroupRegion string
    Data processing location. This is where Fivetran will operate and run computation on data.
    ProxyServerUri string
    The proxy server URI.
    RegistredAt string
    The timestamp of the time the proxy agent was created in your account.
    Salt string
    The salt.
    Token string
    The auth token.
    createdBy String
    The actor who created the proxy agent.
    displayName String
    Proxy agent name.
    groupRegion String
    Data processing location. This is where Fivetran will operate and run computation on data.
    proxyServerUri String
    The proxy server URI.
    registredAt String
    The timestamp of the time the proxy agent was created in your account.
    salt String
    The salt.
    token String
    The auth token.
    createdBy string
    The actor who created the proxy agent.
    displayName string
    Proxy agent name.
    groupRegion string
    Data processing location. This is where Fivetran will operate and run computation on data.
    proxyServerUri string
    The proxy server URI.
    registredAt string
    The timestamp of the time the proxy agent was created in your account.
    salt string
    The salt.
    token string
    The auth token.
    created_by str
    The actor who created the proxy agent.
    display_name str
    Proxy agent name.
    group_region str
    Data processing location. This is where Fivetran will operate and run computation on data.
    proxy_server_uri str
    The proxy server URI.
    registred_at str
    The timestamp of the time the proxy agent was created in your account.
    salt str
    The salt.
    token str
    The auth token.
    createdBy String
    The actor who created the proxy agent.
    displayName String
    Proxy agent name.
    groupRegion String
    Data processing location. This is where Fivetran will operate and run computation on data.
    proxyServerUri String
    The proxy server URI.
    registredAt String
    The timestamp of the time the proxy agent was created in your account.
    salt String
    The salt.
    token String
    The auth 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