Vercel v3.2.1, May 14 25

Vercel v3.2.1 published on Wednesday, May 14, 2025 by Pulumiverse

vercel.MicrofrontendGroup

Explore with Pulumi AI

Vercel v3.2.1 published on Wednesday, May 14, 2025 by Pulumiverse

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 MicrofrontendGroup Resource

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

Constructor syntax

new MicrofrontendGroup(name: string, args: MicrofrontendGroupArgs, opts?: CustomResourceOptions);

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

@overload
def MicrofrontendGroup(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       default_app: Optional[MicrofrontendGroupDefaultAppArgs] = None,
                       name: Optional[str] = None,
                       team_id: Optional[str] = None)

func NewMicrofrontendGroup(ctx *Context, name string, args MicrofrontendGroupArgs, opts ...ResourceOption) (*MicrofrontendGroup, error)

public MicrofrontendGroup(string name, MicrofrontendGroupArgs args, CustomResourceOptions? opts = null)

public MicrofrontendGroup(String name, MicrofrontendGroupArgs args)
public MicrofrontendGroup(String name, MicrofrontendGroupArgs args, CustomResourceOptions options)

type: vercel:MicrofrontendGroup
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 MicrofrontendGroupArgs: 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 MicrofrontendGroupArgs: 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 MicrofrontendGroupArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args MicrofrontendGroupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args MicrofrontendGroupArgs: 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 microfrontendGroupResource = new Vercel.MicrofrontendGroup("microfrontendGroupResource", new()
{
    DefaultApp = new Vercel.Inputs.MicrofrontendGroupDefaultAppArgs
    {
        ProjectId = "string",
        DefaultRoute = "string",
    },
    Name = "string",
    TeamId = "string",
});

example, err := vercel.NewMicrofrontendGroup(ctx, "microfrontendGroupResource", &vercel.MicrofrontendGroupArgs{
	DefaultApp: &vercel.MicrofrontendGroupDefaultAppArgs{
		ProjectId:    pulumi.String("string"),
		DefaultRoute: pulumi.String("string"),
	},
	Name:   pulumi.String("string"),
	TeamId: pulumi.String("string"),
})

var microfrontendGroupResource = new MicrofrontendGroup("microfrontendGroupResource", MicrofrontendGroupArgs.builder()
    .defaultApp(MicrofrontendGroupDefaultAppArgs.builder()
        .projectId("string")
        .defaultRoute("string")
        .build())
    .name("string")
    .teamId("string")
    .build());

microfrontend_group_resource = vercel.MicrofrontendGroup("microfrontendGroupResource",
    default_app={
        "project_id": "string",
        "default_route": "string",
    },
    name="string",
    team_id="string")

const microfrontendGroupResource = new vercel.MicrofrontendGroup("microfrontendGroupResource", {
    defaultApp: {
        projectId: "string",
        defaultRoute: "string",
    },
    name: "string",
    teamId: "string",
});

type: vercel:MicrofrontendGroup
properties:
    defaultApp:
        defaultRoute: string
        projectId: string
    name: string
    teamId: string

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

DefaultApp Pulumiverse.Vercel.Inputs.MicrofrontendGroupDefaultApp: The default app for the project. Used as the entry point for the microfrontend.
Name string: A human readable name for the microfrontends group.
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.

DefaultApp MicrofrontendGroupDefaultAppArgs: The default app for the project. Used as the entry point for the microfrontend.
Name string: A human readable name for the microfrontends group.
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.

defaultApp MicrofrontendGroupDefaultApp: The default app for the project. Used as the entry point for the microfrontend.
name String: A human readable name for the microfrontends group.
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.

defaultApp MicrofrontendGroupDefaultApp: The default app for the project. Used as the entry point for the microfrontend.
name string: A human readable name for the microfrontends group.
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_app MicrofrontendGroupDefaultAppArgs: The default app for the project. Used as the entry point for the microfrontend.
name str: A human readable name for the microfrontends group.
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.

defaultApp Property Map: The default app for the project. Used as the entry point for the microfrontend.
name String: A human readable name for the microfrontends group.
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 MicrofrontendGroup resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.
Slug string: A slugified version of the name.

Id string: The provider-assigned unique ID for this managed resource.
Slug string: A slugified version of the name.

id String: The provider-assigned unique ID for this managed resource.
slug String: A slugified version of the name.

id string: The provider-assigned unique ID for this managed resource.
slug string: A slugified version of the name.

id str: The provider-assigned unique ID for this managed resource.
slug str: A slugified version of the name.

id String: The provider-assigned unique ID for this managed resource.
slug String: A slugified version of the name.

Look up Existing MicrofrontendGroup Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        default_app: Optional[MicrofrontendGroupDefaultAppArgs] = None,
        name: Optional[str] = None,
        slug: Optional[str] = None,
        team_id: Optional[str] = None) -> MicrofrontendGroup

func GetMicrofrontendGroup(ctx *Context, name string, id IDInput, state *MicrofrontendGroupState, opts ...ResourceOption) (*MicrofrontendGroup, error)

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

public static MicrofrontendGroup get(String name, Output<String> id, MicrofrontendGroupState state, CustomResourceOptions options)

resources:  _:    type: vercel:MicrofrontendGroup    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:

DefaultApp Pulumiverse.Vercel.Inputs.MicrofrontendGroupDefaultApp: The default app for the project. Used as the entry point for the microfrontend.
Name string: A human readable name for the microfrontends group.
Slug string: A slugified version of the name.
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.

DefaultApp MicrofrontendGroupDefaultAppArgs: The default app for the project. Used as the entry point for the microfrontend.
Name string: A human readable name for the microfrontends group.
Slug string: A slugified version of the name.
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.

defaultApp MicrofrontendGroupDefaultApp: The default app for the project. Used as the entry point for the microfrontend.
name String: A human readable name for the microfrontends group.
slug String: A slugified version of the name.
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.

defaultApp MicrofrontendGroupDefaultApp: The default app for the project. Used as the entry point for the microfrontend.
name string: A human readable name for the microfrontends group.
slug string: A slugified version of the name.
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_app MicrofrontendGroupDefaultAppArgs: The default app for the project. Used as the entry point for the microfrontend.
name str: A human readable name for the microfrontends group.
slug str: A slugified version of the name.
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.

defaultApp Property Map: The default app for the project. Used as the entry point for the microfrontend.
name String: A human readable name for the microfrontends group.
slug String: A slugified version of the name.
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.

Supporting Types

MicrofrontendGroupDefaultApp, MicrofrontendGroupDefaultAppArgs

ProjectId string: The ID of the project.
DefaultRoute string: The default route for the project. Used for the screenshot of deployments.

ProjectId string: The ID of the project.
DefaultRoute string: The default route for the project. Used for the screenshot of deployments.

projectId String: The ID of the project.
defaultRoute String: The default route for the project. Used for the screenshot of deployments.

projectId string: The ID of the project.
defaultRoute string: The default route for the project. Used for the screenshot of deployments.

project_id str: The ID of the project.
default_route str: The default route for the project. Used for the screenshot of deployments.

projectId String: The ID of the project.
defaultRoute String: The default route for the project. Used for the screenshot of deployments.

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

$ pulumi import vercel:index/microfrontendGroup:MicrofrontendGroup example mfe_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

$ pulumi import vercel:index/microfrontendGroup:MicrofrontendGroup example team_xxxxxxxxxxxxxxxxxxxxxxxx/mfe_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 v3.2.1 published on Wednesday, May 14, 2025 by Pulumiverse

pulumiverse/pulumi-vercel

vercel.MicrofrontendGroup

On this page

On this page

Example Usage

Create MicrofrontendGroup Resource

Constructor syntax

Parameters

Constructor example

MicrofrontendGroup Resource Properties

Inputs

Outputs

Look up Existing MicrofrontendGroup Resource

Supporting Types

MicrofrontendGroupDefaultApp, MicrofrontendGroupDefaultAppArgs

Import

Package Details

On this page

On this page