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

fivetran.UserGroupMembership

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

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fivetran.UserGroupMembership;
import com.pulumi.fivetran.UserGroupMembershipArgs;
import com.pulumi.fivetran.inputs.UserGroupMembershipGroupArgs;
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 testUserGroupMembership = new UserGroupMembership("testUserGroupMembership", UserGroupMembershipArgs.builder()
            .userId("test_user")
            .groups(            
                UserGroupMembershipGroupArgs.builder()
                    .connectorId("test_connector")
                    .groupId("test_group")
                    .role("Destination Administrator")
                    .build(),
                UserGroupMembershipGroupArgs.builder()
                    .connectorId("test_connector")
                    .groupId("test_group")
                    .role("Destination Administrator")
                    .build())
            .build(), CustomResourceOptions.builder()
                .provider(fivetran_provider)
                .build());

    }
}

    resources:
  testUserGroupMembership:
    type: fivetran:UserGroupMembership
    properties:
      userId: test_user
      groups:
        - connectorId: test_connector
          groupId: test_group
          role: Destination Administrator
        - connectorId: test_connector
          groupId: test_group
          role: Destination Administrator
    options:
      provider: ${["fivetran-provider"]}

    Create UserGroupMembership Resource

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

    Constructor syntax

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

@overload
def UserGroupMembership(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        user_id: Optional[str] = None,
                        groups: Optional[Sequence[UserGroupMembershipGroupArgs]] = None)
    func NewUserGroupMembership(ctx *Context, name string, args UserGroupMembershipArgs, opts ...ResourceOption) (*UserGroupMembership, error)
    public UserGroupMembership(string name, UserGroupMembershipArgs args, CustomResourceOptions? opts = null)
    public UserGroupMembership(String name, UserGroupMembershipArgs args)
public UserGroupMembership(String name, UserGroupMembershipArgs args, CustomResourceOptions options)

    type: fivetran:UserGroupMembership
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 UserGroupMembershipArgs
    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 UserGroupMembershipArgs
    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 UserGroupMembershipArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserGroupMembershipArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserGroupMembershipArgs
    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 userGroupMembershipResource = new Fivetran.UserGroupMembership("userGroupMembershipResource", new()
{
    UserId = "string",
    Groups = new[]
    {
        new Fivetran.Inputs.UserGroupMembershipGroupArgs
        {
            GroupId = "string",
            Role = "string",
            CreatedAt = "string",
        },
    },
});

    example, err := fivetran.NewUserGroupMembership(ctx, "userGroupMembershipResource", &fivetran.UserGroupMembershipArgs{
UserId: pulumi.String("string"),
Groups: .UserGroupMembershipGroupArray{
&.UserGroupMembershipGroupArgs{
GroupId: pulumi.String("string"),
Role: pulumi.String("string"),
CreatedAt: pulumi.String("string"),
},
},
})

    var userGroupMembershipResource = new UserGroupMembership("userGroupMembershipResource", UserGroupMembershipArgs.builder()
    .userId("string")
    .groups(UserGroupMembershipGroupArgs.builder()
        .groupId("string")
        .role("string")
        .createdAt("string")
        .build())
    .build());

    user_group_membership_resource = fivetran.UserGroupMembership("userGroupMembershipResource",
    user_id="string",
    groups=[{
        "group_id": "string",
        "role": "string",
        "created_at": "string",
    }])

    const userGroupMembershipResource = new fivetran.UserGroupMembership("userGroupMembershipResource", {
    userId: "string",
    groups: [{
        groupId: "string",
        role: "string",
        createdAt: "string",
    }],
});

    type: fivetran:UserGroupMembership
properties:
    groups:
        - createdAt: string
          groupId: string
          role: string
    userId: string

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

    UserId string
    The unique identifier for the user within your account.
    Groups List<UserGroupMembershipGroup>
    UserId string
    The unique identifier for the user within your account.
    Groups []UserGroupMembershipGroupArgs
    userId String
    The unique identifier for the user within your account.
    groups List<UserGroupMembershipGroup>
    userId string
    The unique identifier for the user within your account.
    groups UserGroupMembershipGroup[]
    user_id str
    The unique identifier for the user within your account.
    groups Sequence[UserGroupMembershipGroupArgs]
    userId String
    The unique identifier for the user within your account.
    groups List<Property Map>

    Outputs

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

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

    Supporting Types

    UserGroupMembershipGroup, UserGroupMembershipGroupArgs

    GroupId string
    The group unique identifier
    Role string
    The user's role that links the user and the group
    CreatedAt string
    The date and time the membership was created
    GroupId string
    The group unique identifier
    Role string
    The user's role that links the user and the group
    CreatedAt string
    The date and time the membership was created
    groupId String
    The group unique identifier
    role String
    The user's role that links the user and the group
    createdAt String
    The date and time the membership was created
    groupId string
    The group unique identifier
    role string
    The user's role that links the user and the group
    createdAt string
    The date and time the membership was created
    group_id str
    The group unique identifier
    role str
    The user's role that links the user and the group
    created_at str
    The date and time the membership was created
    groupId String
    The group unique identifier
    role String
    The user's role that links the user and the group
    createdAt String
    The date and time the membership was created

    Import

    1. To import an existing fivetran_user_group_membership resource into your Terraform state, you need to get user_id and group_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_group_membership” “my_imported_fivetran_user_group_membership” {

    }

    1. Run the pulumi import command:
    $ pulumi import fivetran:index/userGroupMembership:UserGroupMembership my_imported_fivetran_user_group_membership {user_id}
    1. Use the terraform state show command to get the values from the state:

    terraform state show ‘fivetran_user_group_membership.my_imported_fivetran_user_group_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
    fivetran/terraform-provider-fivetran