fivetran.Group

This resource allows you to create, update, and delete groups.

IMPORTANT: Groups and destinations are mapped 1:1 to each other. We do this mapping using the group’s id value that we automatically generate when you create a group using our Terrafrom Provider, and the destination’s group_id value that you specify when you create a destination using our Terrafrom Provider. This means that if you use our Terrafrom Provider to create a destination, you must create a group in your Fivetran account before you can create a destination in it.

When you create a destination in your Fivetran dashboard, we automatically create a group and assign a value to its id and a destination with the same group_id value, which is unique in your Fivetran account. The group’s name corresponds to the Destination name you specify in your Fivetran dashboard when creating the destination in your Fivetran dashboard.

Example Usage

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

const group = new fivetran.Group("group", {});

import pulumi
import pulumi_fivetran as fivetran

group = fivetran.Group("group")

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.NewGroup(ctx, "group", 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 @group = new Fivetran.Group("group");

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fivetran.Group;
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 group = new Group("group");

    }
}

resources:
  group:
    type: fivetran:Group

Create Group Resource

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

Constructor syntax

new Group(name: string, args?: GroupArgs, opts?: CustomResourceOptions);

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

@overload
def Group(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          name: Optional[str] = None)

func NewGroup(ctx *Context, name string, args *GroupArgs, opts ...ResourceOption) (*Group, error)

public Group(string name, GroupArgs? args = null, CustomResourceOptions? opts = null)

public Group(String name, GroupArgs args)
public Group(String name, GroupArgs args, CustomResourceOptions options)

type: fivetran:Group
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

Constructor example

The following reference example uses placeholder values for all input properties.

var groupResource = new Fivetran.Group("groupResource", new()
{
    Name = "string",
});

example, err := fivetran.NewGroup(ctx, "groupResource", &fivetran.GroupArgs{
Name: pulumi.String("string"),
})

var groupResource = new Group("groupResource", GroupArgs.builder()
    .name("string")
    .build());

group_resource = fivetran.Group("groupResource", name="string")

const groupResource = new fivetran.Group("groupResource", {name: "string"});

type: fivetran:Group
properties:
    name: string

Group Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Group resource accepts the following input properties:

Outputs

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

Look up Existing Group Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_at: Optional[str] = None,
        last_updated: Optional[str] = None,
        name: Optional[str] = None) -> Group

func GetGroup(ctx *Context, name string, id IDInput, state *GroupState, opts ...ResourceOption) (*Group, error)

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

public static Group get(String name, Output<String> id, GroupState state, CustomResourceOptions options)

resources:  _:    type: fivetran:Group    get:      id: ${id}

Import

1. To import an existing fivetran_group resource into your Terraform state, you need to get Destination Group ID on the destination page in your Fivetran dashboard.

To retrieve existing groups, use the fivetran_groups data source.

2. Define an empty resource in your .tf configuration:

hcl

resource “fivetran_group” “my_imported_fivetran_group” {

}

3. Run the pulumi import command:

$ pulumi import fivetran:index/group:Group my_imported_fivetran_group {your Destination Group ID}

4. Use the terraform state show command to get the values from the state:

terraform state show ‘fivetran_group.my_imported_fivetran_group’

5. Copy the values and paste them to your .tf configuration.

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.