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

fivetran.UserConnectorMembership

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 connector membership for user

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as fivetran from "@pulumi/fivetran";
    
    const testUserConnectorMembership = new fivetran.UserConnectorMembership("testUserConnectorMembership", {
        userId: "test_user",
        connectors: [
            {
                connectorId: "test_connector",
                role: "Connector Administrator",
                createdAt: "2020-05-25T15:26:47.306509Z",
            },
            {
                connectorId: "test_connector",
                role: "Connector Administrator",
                createdAt: "2020-05-25T15:26:47.306509Z",
            },
        ],
    }, {
        provider: fivetran_provider,
    });
    
    import pulumi
    import pulumi_fivetran as fivetran
    
    test_user_connector_membership = fivetran.UserConnectorMembership("testUserConnectorMembership",
        user_id="test_user",
        connectors=[
            {
                "connector_id": "test_connector",
                "role": "Connector Administrator",
                "created_at": "2020-05-25T15:26:47.306509Z",
            },
            {
                "connector_id": "test_connector",
                "role": "Connector Administrator",
                "created_at": "2020-05-25T15:26:47.306509Z",
            },
        ],
        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.NewUserConnectorMembership(ctx, "testUserConnectorMembership", &fivetran.UserConnectorMembershipArgs{
    			UserId: pulumi.String("test_user"),
    			Connectors: fivetran.UserConnectorMembershipConnectorArray{
    				&fivetran.UserConnectorMembershipConnectorArgs{
    					ConnectorId: pulumi.String("test_connector"),
    					Role:        pulumi.String("Connector Administrator"),
    					CreatedAt:   pulumi.String("2020-05-25T15:26:47.306509Z"),
    				},
    				&fivetran.UserConnectorMembershipConnectorArgs{
    					ConnectorId: pulumi.String("test_connector"),
    					Role:        pulumi.String("Connector Administrator"),
    					CreatedAt:   pulumi.String("2020-05-25T15:26:47.306509Z"),
    				},
    			},
    		}, 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 testUserConnectorMembership = new Fivetran.UserConnectorMembership("testUserConnectorMembership", new()
        {
            UserId = "test_user",
            Connectors = new[]
            {
                new Fivetran.Inputs.UserConnectorMembershipConnectorArgs
                {
                    ConnectorId = "test_connector",
                    Role = "Connector Administrator",
                    CreatedAt = "2020-05-25T15:26:47.306509Z",
                },
                new Fivetran.Inputs.UserConnectorMembershipConnectorArgs
                {
                    ConnectorId = "test_connector",
                    Role = "Connector Administrator",
                    CreatedAt = "2020-05-25T15:26:47.306509Z",
                },
            },
        }, 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.UserConnectorMembership;
    import com.pulumi.fivetran.UserConnectorMembershipArgs;
    import com.pulumi.fivetran.inputs.UserConnectorMembershipConnectorArgs;
    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 testUserConnectorMembership = new UserConnectorMembership("testUserConnectorMembership", UserConnectorMembershipArgs.builder()
                .userId("test_user")
                .connectors(            
                    UserConnectorMembershipConnectorArgs.builder()
                        .connectorId("test_connector")
                        .role("Connector Administrator")
                        .createdAt("2020-05-25T15:26:47.306509Z")
                        .build(),
                    UserConnectorMembershipConnectorArgs.builder()
                        .connectorId("test_connector")
                        .role("Connector Administrator")
                        .createdAt("2020-05-25T15:26:47.306509Z")
                        .build())
                .build(), CustomResourceOptions.builder()
                    .provider(fivetran_provider)
                    .build());
    
        }
    }
    
    resources:
      testUserConnectorMembership:
        type: fivetran:UserConnectorMembership
        properties:
          userId: test_user
          connectors:
            - connectorId: test_connector
              role: Connector Administrator
              createdAt: 2020-05-25T15:26:47.306509Z
            - connectorId: test_connector
              role: Connector Administrator
              createdAt: 2020-05-25T15:26:47.306509Z
        options:
          provider: ${["fivetran-provider"]}
    

    Create UserConnectorMembership Resource

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

    Constructor syntax

    new UserConnectorMembership(name: string, args: UserConnectorMembershipArgs, opts?: CustomResourceOptions);
    @overload
    def UserConnectorMembership(resource_name: str,
                                args: UserConnectorMembershipArgs,
                                opts: Optional[ResourceOptions] = None)
    
    @overload
    def UserConnectorMembership(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                user_id: Optional[str] = None,
                                connectors: Optional[Sequence[UserConnectorMembershipConnectorArgs]] = None)
    func NewUserConnectorMembership(ctx *Context, name string, args UserConnectorMembershipArgs, opts ...ResourceOption) (*UserConnectorMembership, error)
    public UserConnectorMembership(string name, UserConnectorMembershipArgs args, CustomResourceOptions? opts = null)
    public UserConnectorMembership(String name, UserConnectorMembershipArgs args)
    public UserConnectorMembership(String name, UserConnectorMembershipArgs args, CustomResourceOptions options)
    
    type: fivetran:UserConnectorMembership
    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 UserConnectorMembershipArgs
    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 UserConnectorMembershipArgs
    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 UserConnectorMembershipArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserConnectorMembershipArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserConnectorMembershipArgs
    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 userConnectorMembershipResource = new Fivetran.UserConnectorMembership("userConnectorMembershipResource", new()
    {
        UserId = "string",
        Connectors = new[]
        {
            new Fivetran.Inputs.UserConnectorMembershipConnectorArgs
            {
                ConnectorId = "string",
                Role = "string",
                CreatedAt = "string",
            },
        },
    });
    
    example, err := fivetran.NewUserConnectorMembership(ctx, "userConnectorMembershipResource", &fivetran.UserConnectorMembershipArgs{
    UserId: pulumi.String("string"),
    Connectors: .UserConnectorMembershipConnectorArray{
    &.UserConnectorMembershipConnectorArgs{
    ConnectorId: pulumi.String("string"),
    Role: pulumi.String("string"),
    CreatedAt: pulumi.String("string"),
    },
    },
    })
    
    var userConnectorMembershipResource = new UserConnectorMembership("userConnectorMembershipResource", UserConnectorMembershipArgs.builder()
        .userId("string")
        .connectors(UserConnectorMembershipConnectorArgs.builder()
            .connectorId("string")
            .role("string")
            .createdAt("string")
            .build())
        .build());
    
    user_connector_membership_resource = fivetran.UserConnectorMembership("userConnectorMembershipResource",
        user_id="string",
        connectors=[{
            "connector_id": "string",
            "role": "string",
            "created_at": "string",
        }])
    
    const userConnectorMembershipResource = new fivetran.UserConnectorMembership("userConnectorMembershipResource", {
        userId: "string",
        connectors: [{
            connectorId: "string",
            role: "string",
            createdAt: "string",
        }],
    });
    
    type: fivetran:UserConnectorMembership
    properties:
        connectors:
            - connectorId: string
              createdAt: string
              role: string
        userId: string
    

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

    UserId string
    The unique identifier for the user within your account.
    Connectors List<UserConnectorMembershipConnector>
    UserId string
    The unique identifier for the user within your account.
    Connectors []UserConnectorMembershipConnectorArgs
    userId String
    The unique identifier for the user within your account.
    connectors List<UserConnectorMembershipConnector>
    userId string
    The unique identifier for the user within your account.
    connectors UserConnectorMembershipConnector[]
    user_id str
    The unique identifier for the user within your account.
    connectors Sequence[UserConnectorMembershipConnectorArgs]
    userId String
    The unique identifier for the user within your account.
    connectors List<Property Map>

    Outputs

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

    Get an existing UserConnectorMembership 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?: UserConnectorMembershipState, opts?: CustomResourceOptions): UserConnectorMembership
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            connectors: Optional[Sequence[UserConnectorMembershipConnectorArgs]] = None,
            user_id: Optional[str] = None) -> UserConnectorMembership
    func GetUserConnectorMembership(ctx *Context, name string, id IDInput, state *UserConnectorMembershipState, opts ...ResourceOption) (*UserConnectorMembership, error)
    public static UserConnectorMembership Get(string name, Input<string> id, UserConnectorMembershipState? state, CustomResourceOptions? opts = null)
    public static UserConnectorMembership get(String name, Output<String> id, UserConnectorMembershipState state, CustomResourceOptions options)
    resources:  _:    type: fivetran:UserConnectorMembership    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:
    Connectors List<UserConnectorMembershipConnector>
    UserId string
    The unique identifier for the user within your account.
    Connectors []UserConnectorMembershipConnectorArgs
    UserId string
    The unique identifier for the user within your account.
    connectors List<UserConnectorMembershipConnector>
    userId String
    The unique identifier for the user within your account.
    connectors UserConnectorMembershipConnector[]
    userId string
    The unique identifier for the user within your account.
    connectors Sequence[UserConnectorMembershipConnectorArgs]
    user_id str
    The unique identifier for the user within your account.
    connectors List<Property Map>
    userId String
    The unique identifier for the user within your account.

    Supporting Types

    UserConnectorMembershipConnector, UserConnectorMembershipConnectorArgs

    ConnectorId string
    The connector unique identifier
    Role string
    The user's role that links the user and the connector
    CreatedAt string
    The date and time the membership was created
    ConnectorId string
    The connector unique identifier
    Role string
    The user's role that links the user and the connector
    CreatedAt string
    The date and time the membership was created
    connectorId String
    The connector unique identifier
    role String
    The user's role that links the user and the connector
    createdAt String
    The date and time the membership was created
    connectorId string
    The connector unique identifier
    role string
    The user's role that links the user and the connector
    createdAt string
    The date and time the membership was created
    connector_id str
    The connector unique identifier
    role str
    The user's role that links the user and the connector
    created_at str
    The date and time the membership was created
    connectorId String
    The connector unique identifier
    role String
    The user's role that links the user and the connector
    createdAt String
    The date and time the membership was created

    Import

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

    You can retrieve all users using the fivetran_users data source.

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

    hcl

    resource “fivetran_user_connector_membership” “my_imported_fivetran_user_connector_membership” {

    }

    1. Run the pulumi import command:
    $ pulumi import fivetran:index/userConnectorMembership:UserConnectorMembership my_imported_fivetran_user_connector_membership {user_id}
    
    1. Use the terraform state show command to get the values from the state:

    terraform state show ‘fivetran_user_connector_membership.my_imported_fivetran_user_connector_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