1. Packages
  2. Fivetran Provider
  3. API Docs
  4. TeamUserMembership
fivetran 1.6.0 published on Tuesday, Mar 25, 2025 by fivetran

fivetran.TeamUserMembership

Explore with Pulumi AI

fivetran logo
fivetran 1.6.0 published on Tuesday, Mar 25, 2025 by fivetran

    This resource allows you to create, update, and delete user membership for teams

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as fivetran from "@pulumi/fivetran";
    
    const testTeamUserMembership = new fivetran.TeamUserMembership("testTeamUserMembership", {
        teamId: "test_team",
        users: [
            {
                userId: "test_user",
                role: "Connector Administrator",
            },
            {
                userId: "test_user",
                role: "Connector Administrator",
            },
        ],
    }, {
        provider: fivetran_provider,
    });
    
    import pulumi
    import pulumi_fivetran as fivetran
    
    test_team_user_membership = fivetran.TeamUserMembership("testTeamUserMembership",
        team_id="test_team",
        users=[
            {
                "user_id": "test_user",
                "role": "Connector Administrator",
            },
            {
                "user_id": "test_user",
                "role": "Connector Administrator",
            },
        ],
        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.NewTeamUserMembership(ctx, "testTeamUserMembership", &fivetran.TeamUserMembershipArgs{
    			TeamId: pulumi.String("test_team"),
    			Users: fivetran.TeamUserMembershipUserArray{
    				&fivetran.TeamUserMembershipUserArgs{
    					UserId: pulumi.String("test_user"),
    					Role:   pulumi.String("Connector Administrator"),
    				},
    				&fivetran.TeamUserMembershipUserArgs{
    					UserId: pulumi.String("test_user"),
    					Role:   pulumi.String("Connector Administrator"),
    				},
    			},
    		}, 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 testTeamUserMembership = new Fivetran.TeamUserMembership("testTeamUserMembership", new()
        {
            TeamId = "test_team",
            Users = new[]
            {
                new Fivetran.Inputs.TeamUserMembershipUserArgs
                {
                    UserId = "test_user",
                    Role = "Connector Administrator",
                },
                new Fivetran.Inputs.TeamUserMembershipUserArgs
                {
                    UserId = "test_user",
                    Role = "Connector Administrator",
                },
            },
        }, 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.TeamUserMembership;
    import com.pulumi.fivetran.TeamUserMembershipArgs;
    import com.pulumi.fivetran.inputs.TeamUserMembershipUserArgs;
    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 testTeamUserMembership = new TeamUserMembership("testTeamUserMembership", TeamUserMembershipArgs.builder()
                .teamId("test_team")
                .users(            
                    TeamUserMembershipUserArgs.builder()
                        .userId("test_user")
                        .role("Connector Administrator")
                        .build(),
                    TeamUserMembershipUserArgs.builder()
                        .userId("test_user")
                        .role("Connector Administrator")
                        .build())
                .build(), CustomResourceOptions.builder()
                    .provider(fivetran_provider)
                    .build());
    
        }
    }
    
    resources:
      testTeamUserMembership:
        type: fivetran:TeamUserMembership
        properties:
          teamId: test_team
          users:
            - userId: test_user
              role: Connector Administrator
            - userId: test_user
              role: Connector Administrator
        options:
          provider: ${["fivetran-provider"]}
    

    Create TeamUserMembership Resource

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

    Constructor syntax

    new TeamUserMembership(name: string, args: TeamUserMembershipArgs, opts?: CustomResourceOptions);
    @overload
    def TeamUserMembership(resource_name: str,
                           args: TeamUserMembershipArgs,
                           opts: Optional[ResourceOptions] = None)
    
    @overload
    def TeamUserMembership(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           team_id: Optional[str] = None,
                           users: Optional[Sequence[TeamUserMembershipUserArgs]] = None)
    func NewTeamUserMembership(ctx *Context, name string, args TeamUserMembershipArgs, opts ...ResourceOption) (*TeamUserMembership, error)
    public TeamUserMembership(string name, TeamUserMembershipArgs args, CustomResourceOptions? opts = null)
    public TeamUserMembership(String name, TeamUserMembershipArgs args)
    public TeamUserMembership(String name, TeamUserMembershipArgs args, CustomResourceOptions options)
    
    type: fivetran:TeamUserMembership
    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 TeamUserMembershipArgs
    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 TeamUserMembershipArgs
    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 TeamUserMembershipArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TeamUserMembershipArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TeamUserMembershipArgs
    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 teamUserMembershipResource = new Fivetran.TeamUserMembership("teamUserMembershipResource", new()
    {
        TeamId = "string",
        Users = new[]
        {
            new Fivetran.Inputs.TeamUserMembershipUserArgs
            {
                Role = "string",
                UserId = "string",
            },
        },
    });
    
    example, err := fivetran.NewTeamUserMembership(ctx, "teamUserMembershipResource", &fivetran.TeamUserMembershipArgs{
    TeamId: pulumi.String("string"),
    Users: .TeamUserMembershipUserArray{
    &.TeamUserMembershipUserArgs{
    Role: pulumi.String("string"),
    UserId: pulumi.String("string"),
    },
    },
    })
    
    var teamUserMembershipResource = new TeamUserMembership("teamUserMembershipResource", TeamUserMembershipArgs.builder()
        .teamId("string")
        .users(TeamUserMembershipUserArgs.builder()
            .role("string")
            .userId("string")
            .build())
        .build());
    
    team_user_membership_resource = fivetran.TeamUserMembership("teamUserMembershipResource",
        team_id="string",
        users=[{
            "role": "string",
            "user_id": "string",
        }])
    
    const teamUserMembershipResource = new fivetran.TeamUserMembership("teamUserMembershipResource", {
        teamId: "string",
        users: [{
            role: "string",
            userId: "string",
        }],
    });
    
    type: fivetran:TeamUserMembership
    properties:
        teamId: string
        users:
            - role: string
              userId: string
    

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

    TeamId string
    The unique identifier for the team within your account.
    Users List<TeamUserMembershipUser>
    TeamId string
    The unique identifier for the team within your account.
    Users []TeamUserMembershipUserArgs
    teamId String
    The unique identifier for the team within your account.
    users List<TeamUserMembershipUser>
    teamId string
    The unique identifier for the team within your account.
    users TeamUserMembershipUser[]
    team_id str
    The unique identifier for the team within your account.
    users Sequence[TeamUserMembershipUserArgs]
    teamId String
    The unique identifier for the team within your account.
    users List<Property Map>

    Outputs

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

    Get an existing TeamUserMembership 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?: TeamUserMembershipState, opts?: CustomResourceOptions): TeamUserMembership
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            team_id: Optional[str] = None,
            users: Optional[Sequence[TeamUserMembershipUserArgs]] = None) -> TeamUserMembership
    func GetTeamUserMembership(ctx *Context, name string, id IDInput, state *TeamUserMembershipState, opts ...ResourceOption) (*TeamUserMembership, error)
    public static TeamUserMembership Get(string name, Input<string> id, TeamUserMembershipState? state, CustomResourceOptions? opts = null)
    public static TeamUserMembership get(String name, Output<String> id, TeamUserMembershipState state, CustomResourceOptions options)
    resources:  _:    type: fivetran:TeamUserMembership    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:
    TeamId string
    The unique identifier for the team within your account.
    Users List<TeamUserMembershipUser>
    TeamId string
    The unique identifier for the team within your account.
    Users []TeamUserMembershipUserArgs
    teamId String
    The unique identifier for the team within your account.
    users List<TeamUserMembershipUser>
    teamId string
    The unique identifier for the team within your account.
    users TeamUserMembershipUser[]
    team_id str
    The unique identifier for the team within your account.
    users Sequence[TeamUserMembershipUserArgs]
    teamId String
    The unique identifier for the team within your account.
    users List<Property Map>

    Supporting Types

    TeamUserMembershipUser, TeamUserMembershipUserArgs

    Role string
    The team's role that links the team and the user
    UserId string
    The user unique identifier
    Role string
    The team's role that links the team and the user
    UserId string
    The user unique identifier
    role String
    The team's role that links the team and the user
    userId String
    The user unique identifier
    role string
    The team's role that links the team and the user
    userId string
    The user unique identifier
    role str
    The team's role that links the team and the user
    user_id str
    The user unique identifier
    role String
    The team's role that links the team and the user
    userId String
    The user unique identifier

    Import

    1. To import an existing fivetran_team_user_membership resource into your Terraform state, you need to get team_id and user_id

    You can retrieve all teams using the fivetran_teams data source.

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

    hcl

    resource “fivetran_team_user_membership” “my_imported_fivetran_team_user_membership” {

    }

    1. Run the pulumi import command:
    $ pulumi import fivetran:index/teamUserMembership:TeamUserMembership my_imported_fivetran_team_user_membership {team_id}
    
    1. Use the terraform state show command to get the values from the state:

    terraform state show ‘fivetran_team_user_membership.my_imported_fivetran_team_user_membership’

    1. 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.
    fivetran logo
    fivetran 1.6.0 published on Tuesday, Mar 25, 2025 by fivetran