Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vercel Provider
  3. API Docs
  4. MicrofrontendGroupMembership
Vercel v3.2.1 published on Wednesday, May 14, 2025 by Pulumiverse
pulumiverse/pulumi-vercel

vercel.MicrofrontendGroupMembership

Explore with Pulumi AI

vercel logo
Vercel v3.2.1 published on Wednesday, May 14, 2025 by Pulumiverse
pulumiverse/pulumi-vercel

    Provides a Microfrontend Group Membership resource.

    A Microfrontend Group Membership is a definition of a Vercel Project being a part of a Microfrontend Group.

    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.vercel.VercelFunctions;
import com.pulumi.vercel.inputs.GetProjectArgs;
import com.pulumi.vercel.MicrofrontendGroup;
import com.pulumi.vercel.MicrofrontendGroupArgs;
import com.pulumi.vercel.inputs.MicrofrontendGroupDefaultAppArgs;
import com.pulumi.vercel.MicrofrontendGroupMembership;
import com.pulumi.vercel.MicrofrontendGroupMembershipArgs;
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) {
        final var parentMfeProject = VercelFunctions.getProject(GetProjectArgs.builder()
            .name("my parent project")
            .build());

        final var childMfeProject = VercelFunctions.getProject(GetProjectArgs.builder()
            .name("my child project")
            .build());

        var exampleMfeGroup = new MicrofrontendGroup("exampleMfeGroup", MicrofrontendGroupArgs.builder()
            .name("my mfe")
            .defaultApp(MicrofrontendGroupDefaultAppArgs.builder()
                .project_id(parentMfeProject.applyValue(getProjectResult -> getProjectResult.id()))
                .build())
            .build());

        var childMfeProjectMfeMembership = new MicrofrontendGroupMembership("childMfeProjectMfeMembership", MicrofrontendGroupMembershipArgs.builder()
            .projectId(childMfeProjectVercelProject.id())
            .microfrontendGroupId(exampleMfeGroup.id())
            .build());

    }
}

    resources:
  exampleMfeGroup:
    type: vercel:MicrofrontendGroup
    name: example_mfe_group
    properties:
      name: my mfe
      defaultApp:
        project_id: ${parentMfeProject.id}
  childMfeProjectMfeMembership:
    type: vercel:MicrofrontendGroupMembership
    name: child_mfe_project_mfe_membership
    properties:
      projectId: ${childMfeProjectVercelProject.id}
      microfrontendGroupId: ${exampleMfeGroup.id}
variables:
  parentMfeProject:
    fn::invoke:
      Function: vercel:getProject
      Arguments:
        name: my parent project
  childMfeProject:
    fn::invoke:
      Function: vercel:getProject
      Arguments:
        name: my child project

    Create MicrofrontendGroupMembership Resource

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

    Constructor syntax

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

@overload
def MicrofrontendGroupMembership(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 microfrontend_group_id: Optional[str] = None,
                                 project_id: Optional[str] = None,
                                 default_route: Optional[str] = None,
                                 route_observability_to_this_project: Optional[bool] = None,
                                 team_id: Optional[str] = None)
    func NewMicrofrontendGroupMembership(ctx *Context, name string, args MicrofrontendGroupMembershipArgs, opts ...ResourceOption) (*MicrofrontendGroupMembership, error)
    public MicrofrontendGroupMembership(string name, MicrofrontendGroupMembershipArgs args, CustomResourceOptions? opts = null)
    public MicrofrontendGroupMembership(String name, MicrofrontendGroupMembershipArgs args)
public MicrofrontendGroupMembership(String name, MicrofrontendGroupMembershipArgs args, CustomResourceOptions options)

    type: vercel:MicrofrontendGroupMembership
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 MicrofrontendGroupMembershipArgs
    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 MicrofrontendGroupMembershipArgs
    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 MicrofrontendGroupMembershipArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MicrofrontendGroupMembershipArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MicrofrontendGroupMembershipArgs
    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 microfrontendGroupMembershipResource = new Vercel.MicrofrontendGroupMembership("microfrontendGroupMembershipResource", new()
{
    MicrofrontendGroupId = "string",
    ProjectId = "string",
    DefaultRoute = "string",
    RouteObservabilityToThisProject = false,
    TeamId = "string",
});

    example, err := vercel.NewMicrofrontendGroupMembership(ctx, "microfrontendGroupMembershipResource", &vercel.MicrofrontendGroupMembershipArgs{
	MicrofrontendGroupId:            pulumi.String("string"),
	ProjectId:                       pulumi.String("string"),
	DefaultRoute:                    pulumi.String("string"),
	RouteObservabilityToThisProject: pulumi.Bool(false),
	TeamId:                          pulumi.String("string"),
})

    var microfrontendGroupMembershipResource = new MicrofrontendGroupMembership("microfrontendGroupMembershipResource", MicrofrontendGroupMembershipArgs.builder()
    .microfrontendGroupId("string")
    .projectId("string")
    .defaultRoute("string")
    .routeObservabilityToThisProject(false)
    .teamId("string")
    .build());

    microfrontend_group_membership_resource = vercel.MicrofrontendGroupMembership("microfrontendGroupMembershipResource",
    microfrontend_group_id="string",
    project_id="string",
    default_route="string",
    route_observability_to_this_project=False,
    team_id="string")

    const microfrontendGroupMembershipResource = new vercel.MicrofrontendGroupMembership("microfrontendGroupMembershipResource", {
    microfrontendGroupId: "string",
    projectId: "string",
    defaultRoute: "string",
    routeObservabilityToThisProject: false,
    teamId: "string",
});

    type: vercel:MicrofrontendGroupMembership
properties:
    defaultRoute: string
    microfrontendGroupId: string
    projectId: string
    routeObservabilityToThisProject: false
    teamId: string

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

    MicrofrontendGroupId string
    The ID of the microfrontend group.
    ProjectId string
    The ID of the project.
    DefaultRoute string
    The default route for the project. Used for the screenshot of deployments.
    RouteObservabilityToThisProject bool
    Whether the project is route observability for this project. If dalse, the project will be route observability for all projects to the default project.
    TeamId string
    The team ID to add the microfrontend group to. Required when configuring a team resource if a default team has not been set in the provider.
    MicrofrontendGroupId string
    The ID of the microfrontend group.
    ProjectId string
    The ID of the project.
    DefaultRoute string
    The default route for the project. Used for the screenshot of deployments.
    RouteObservabilityToThisProject bool
    Whether the project is route observability for this project. If dalse, the project will be route observability for all projects to the default project.
    TeamId string
    The team ID to add the microfrontend group to. Required when configuring a team resource if a default team has not been set in the provider.
    microfrontendGroupId String
    The ID of the microfrontend group.
    projectId String
    The ID of the project.
    defaultRoute String
    The default route for the project. Used for the screenshot of deployments.
    routeObservabilityToThisProject Boolean
    Whether the project is route observability for this project. If dalse, the project will be route observability for all projects to the default project.
    teamId String
    The team ID to add the microfrontend group to. Required when configuring a team resource if a default team has not been set in the provider.
    microfrontendGroupId string
    The ID of the microfrontend group.
    projectId string
    The ID of the project.
    defaultRoute string
    The default route for the project. Used for the screenshot of deployments.
    routeObservabilityToThisProject boolean
    Whether the project is route observability for this project. If dalse, the project will be route observability for all projects to the default project.
    teamId string
    The team ID to add the microfrontend group to. Required when configuring a team resource if a default team has not been set in the provider.
    microfrontend_group_id str
    The ID of the microfrontend group.
    project_id str
    The ID of the project.
    default_route str
    The default route for the project. Used for the screenshot of deployments.
    route_observability_to_this_project bool
    Whether the project is route observability for this project. If dalse, the project will be route observability for all projects to the default project.
    team_id str
    The team ID to add the microfrontend group to. Required when configuring a team resource if a default team has not been set in the provider.
    microfrontendGroupId String
    The ID of the microfrontend group.
    projectId String
    The ID of the project.
    defaultRoute String
    The default route for the project. Used for the screenshot of deployments.
    routeObservabilityToThisProject Boolean
    Whether the project is route observability for this project. If dalse, the project will be route observability for all projects to the default project.
    teamId String
    The team ID to add the microfrontend group to. Required when configuring a team resource if a default team has not been set in the provider.

    Outputs

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

    Get an existing MicrofrontendGroupMembership 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?: MicrofrontendGroupMembershipState, opts?: CustomResourceOptions): MicrofrontendGroupMembership
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        default_route: Optional[str] = None,
        microfrontend_group_id: Optional[str] = None,
        project_id: Optional[str] = None,
        route_observability_to_this_project: Optional[bool] = None,
        team_id: Optional[str] = None) -> MicrofrontendGroupMembership
    func GetMicrofrontendGroupMembership(ctx *Context, name string, id IDInput, state *MicrofrontendGroupMembershipState, opts ...ResourceOption) (*MicrofrontendGroupMembership, error)
    public static MicrofrontendGroupMembership Get(string name, Input<string> id, MicrofrontendGroupMembershipState? state, CustomResourceOptions? opts = null)
    public static MicrofrontendGroupMembership get(String name, Output<String> id, MicrofrontendGroupMembershipState state, CustomResourceOptions options)
    resources:  _:    type: vercel:MicrofrontendGroupMembership    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:
    DefaultRoute string
    The default route for the project. Used for the screenshot of deployments.
    MicrofrontendGroupId string
    The ID of the microfrontend group.
    ProjectId string
    The ID of the project.
    RouteObservabilityToThisProject bool
    Whether the project is route observability for this project. If dalse, the project will be route observability for all projects to the default project.
    TeamId string
    The team ID to add the microfrontend group to. Required when configuring a team resource if a default team has not been set in the provider.
    DefaultRoute string
    The default route for the project. Used for the screenshot of deployments.
    MicrofrontendGroupId string
    The ID of the microfrontend group.
    ProjectId string
    The ID of the project.
    RouteObservabilityToThisProject bool
    Whether the project is route observability for this project. If dalse, the project will be route observability for all projects to the default project.
    TeamId string
    The team ID to add the microfrontend group to. Required when configuring a team resource if a default team has not been set in the provider.
    defaultRoute String
    The default route for the project. Used for the screenshot of deployments.
    microfrontendGroupId String
    The ID of the microfrontend group.
    projectId String
    The ID of the project.
    routeObservabilityToThisProject Boolean
    Whether the project is route observability for this project. If dalse, the project will be route observability for all projects to the default project.
    teamId String
    The team ID to add the microfrontend group to. Required when configuring a team resource if a default team has not been set in the provider.
    defaultRoute string
    The default route for the project. Used for the screenshot of deployments.
    microfrontendGroupId string
    The ID of the microfrontend group.
    projectId string
    The ID of the project.
    routeObservabilityToThisProject boolean
    Whether the project is route observability for this project. If dalse, the project will be route observability for all projects to the default project.
    teamId string
    The team ID to add the microfrontend group to. Required when configuring a team resource if a default team has not been set in the provider.
    default_route str
    The default route for the project. Used for the screenshot of deployments.
    microfrontend_group_id str
    The ID of the microfrontend group.
    project_id str
    The ID of the project.
    route_observability_to_this_project bool
    Whether the project is route observability for this project. If dalse, the project will be route observability for all projects to the default project.
    team_id str
    The team ID to add the microfrontend group to. Required when configuring a team resource if a default team has not been set in the provider.
    defaultRoute String
    The default route for the project. Used for the screenshot of deployments.
    microfrontendGroupId String
    The ID of the microfrontend group.
    projectId String
    The ID of the project.
    routeObservabilityToThisProject Boolean
    Whether the project is route observability for this project. If dalse, the project will be route observability for all projects to the default project.
    teamId String
    The team ID to add the microfrontend group to. Required when configuring a team resource if a default team has not been set in the provider.

    Import

    If importing into a personal account, or with a team configured on the provider, simply use the record id.

    • the microfrontend ID can be taken from the microfrontend settings page

    • the project ID can be taken from the project settings page

    $ pulumi import vercel:index/microfrontendGroupMembership:MicrofrontendGroupMembership example mfe_xxxxxxxxxxxxxxxxxxxxxxxxxxxx/pid_xxxxxxxxxxxxxxxxxxxxxxxxxxxx

    Alternatively, you can import via the team_id and microfrontend_id.

    • team_id can be found in the team settings tab in the Vercel UI.

    • the microfrontend ID can be taken from the microfrontend settings page

    • the project ID can be taken from the project settings page

    $ pulumi import vercel:index/microfrontendGroupMembership:MicrofrontendGroupMembership example team_xxxxxxxxxxxxxxxxxxxxxxxx/mfe_xxxxxxxxxxxxxxxxxxxxxxxxxxxx/pid_xxxxxxxxxxxxxxxxxxxxxxxxxxxx

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    vercel pulumiverse/pulumi-vercel
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the vercel Terraform Provider.
    vercel logo
    Vercel v3.2.1 published on Wednesday, May 14, 2025 by Pulumiverse
    pulumiverse/pulumi-vercel