Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vercel Provider
  3. API Docs
  4. AccessGroupProject
Vercel v3.1.2 published on Tuesday, May 13, 2025 by Pulumiverse
pulumiverse/pulumi-vercel

vercel.AccessGroupProject

Explore with Pulumi AI

vercel logo
Vercel v3.1.2 published on Tuesday, May 13, 2025 by Pulumiverse
pulumiverse/pulumi-vercel

    Provides an Access Group Project Resource.

    An Access Group Project resource defines the relationship between a vercel.AccessGroup and a vercel.Project.

    For more detailed information, please see the Vercel documentation.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as vercel from "@pulumiverse/vercel";

const example = new vercel.Project("example", {name: "example-project"});
const exampleAccessGroup = new vercel.AccessGroup("example", {name: "example-access-group"});
const exampleAccessGroupProject = new vercel.AccessGroupProject("example", {
    projectId: example.id,
    accessGroupId: exampleAccessGroup.id,
    role: "ADMIN",
});

    import pulumi
import pulumiverse_vercel as vercel

example = vercel.Project("example", name="example-project")
example_access_group = vercel.AccessGroup("example", name="example-access-group")
example_access_group_project = vercel.AccessGroupProject("example",
    project_id=example.id,
    access_group_id=example_access_group.id,
    role="ADMIN")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-vercel/sdk/v3/go/vercel"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := vercel.NewProject(ctx, "example", &vercel.ProjectArgs{
			Name: pulumi.String("example-project"),
		})
		if err != nil {
			return err
		}
		exampleAccessGroup, err := vercel.NewAccessGroup(ctx, "example", &vercel.AccessGroupArgs{
			Name: pulumi.String("example-access-group"),
		})
		if err != nil {
			return err
		}
		_, err = vercel.NewAccessGroupProject(ctx, "example", &vercel.AccessGroupProjectArgs{
			ProjectId:     example.ID(),
			AccessGroupId: exampleAccessGroup.ID(),
			Role:          pulumi.String("ADMIN"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vercel = Pulumiverse.Vercel;

return await Deployment.RunAsync(() => 
{
    var example = new Vercel.Project("example", new()
    {
        Name = "example-project",
    });

    var exampleAccessGroup = new Vercel.AccessGroup("example", new()
    {
        Name = "example-access-group",
    });

    var exampleAccessGroupProject = new Vercel.AccessGroupProject("example", new()
    {
        ProjectId = example.Id,
        AccessGroupId = exampleAccessGroup.Id,
        Role = "ADMIN",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vercel.Project;
import com.pulumi.vercel.ProjectArgs;
import com.pulumi.vercel.AccessGroup;
import com.pulumi.vercel.AccessGroupArgs;
import com.pulumi.vercel.AccessGroupProject;
import com.pulumi.vercel.AccessGroupProjectArgs;
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 example = new Project("example", ProjectArgs.builder()
            .name("example-project")
            .build());

        var exampleAccessGroup = new AccessGroup("exampleAccessGroup", AccessGroupArgs.builder()
            .name("example-access-group")
            .build());

        var exampleAccessGroupProject = new AccessGroupProject("exampleAccessGroupProject", AccessGroupProjectArgs.builder()
            .projectId(example.id())
            .accessGroupId(exampleAccessGroup.id())
            .role("ADMIN")
            .build());

    }
}

    resources:
  example:
    type: vercel:Project
    properties:
      name: example-project
  exampleAccessGroup:
    type: vercel:AccessGroup
    name: example
    properties:
      name: example-access-group
  exampleAccessGroupProject:
    type: vercel:AccessGroupProject
    name: example
    properties:
      projectId: ${example.id}
      accessGroupId: ${exampleAccessGroup.id}
      role: ADMIN

    Create AccessGroupProject Resource

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

    Constructor syntax

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

@overload
def AccessGroupProject(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       access_group_id: Optional[str] = None,
                       project_id: Optional[str] = None,
                       role: Optional[str] = None,
                       team_id: Optional[str] = None)
    func NewAccessGroupProject(ctx *Context, name string, args AccessGroupProjectArgs, opts ...ResourceOption) (*AccessGroupProject, error)
    public AccessGroupProject(string name, AccessGroupProjectArgs args, CustomResourceOptions? opts = null)
    public AccessGroupProject(String name, AccessGroupProjectArgs args)
public AccessGroupProject(String name, AccessGroupProjectArgs args, CustomResourceOptions options)

    type: vercel:AccessGroupProject
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 AccessGroupProjectArgs
    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 AccessGroupProjectArgs
    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 AccessGroupProjectArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AccessGroupProjectArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AccessGroupProjectArgs
    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 accessGroupProjectResource = new Vercel.AccessGroupProject("accessGroupProjectResource", new()
{
    AccessGroupId = "string",
    ProjectId = "string",
    Role = "string",
    TeamId = "string",
});

    example, err := vercel.NewAccessGroupProject(ctx, "accessGroupProjectResource", &vercel.AccessGroupProjectArgs{
	AccessGroupId: pulumi.String("string"),
	ProjectId:     pulumi.String("string"),
	Role:          pulumi.String("string"),
	TeamId:        pulumi.String("string"),
})

    var accessGroupProjectResource = new AccessGroupProject("accessGroupProjectResource", AccessGroupProjectArgs.builder()
    .accessGroupId("string")
    .projectId("string")
    .role("string")
    .teamId("string")
    .build());

    access_group_project_resource = vercel.AccessGroupProject("accessGroupProjectResource",
    access_group_id="string",
    project_id="string",
    role="string",
    team_id="string")

    const accessGroupProjectResource = new vercel.AccessGroupProject("accessGroupProjectResource", {
    accessGroupId: "string",
    projectId: "string",
    role: "string",
    teamId: "string",
});

    type: vercel:AccessGroupProject
properties:
    accessGroupId: string
    projectId: string
    role: string
    teamId: string

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

    AccessGroupId string
    The ID of the Access Group.
    ProjectId string
    The Project ID to assign to the access group.
    Role string
    The project role to assign to the access group. Must be either ADMIN, PROJECT_DEVELOPER, or PROJECT_VIEWER.
    TeamId string
    The ID of the team the access group project should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    AccessGroupId string
    The ID of the Access Group.
    ProjectId string
    The Project ID to assign to the access group.
    Role string
    The project role to assign to the access group. Must be either ADMIN, PROJECT_DEVELOPER, or PROJECT_VIEWER.
    TeamId string
    The ID of the team the access group project should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    accessGroupId String
    The ID of the Access Group.
    projectId String
    The Project ID to assign to the access group.
    role String
    The project role to assign to the access group. Must be either ADMIN, PROJECT_DEVELOPER, or PROJECT_VIEWER.
    teamId String
    The ID of the team the access group project should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    accessGroupId string
    The ID of the Access Group.
    projectId string
    The Project ID to assign to the access group.
    role string
    The project role to assign to the access group. Must be either ADMIN, PROJECT_DEVELOPER, or PROJECT_VIEWER.
    teamId string
    The ID of the team the access group project should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    access_group_id str
    The ID of the Access Group.
    project_id str
    The Project ID to assign to the access group.
    role str
    The project role to assign to the access group. Must be either ADMIN, PROJECT_DEVELOPER, or PROJECT_VIEWER.
    team_id str
    The ID of the team the access group project should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    accessGroupId String
    The ID of the Access Group.
    projectId String
    The Project ID to assign to the access group.
    role String
    The project role to assign to the access group. Must be either ADMIN, PROJECT_DEVELOPER, or PROJECT_VIEWER.
    teamId String
    The ID of the team the access group project should exist under. 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 AccessGroupProject 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 AccessGroupProject Resource

    Get an existing AccessGroupProject 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?: AccessGroupProjectState, opts?: CustomResourceOptions): AccessGroupProject
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_group_id: Optional[str] = None,
        project_id: Optional[str] = None,
        role: Optional[str] = None,
        team_id: Optional[str] = None) -> AccessGroupProject
    func GetAccessGroupProject(ctx *Context, name string, id IDInput, state *AccessGroupProjectState, opts ...ResourceOption) (*AccessGroupProject, error)
    public static AccessGroupProject Get(string name, Input<string> id, AccessGroupProjectState? state, CustomResourceOptions? opts = null)
    public static AccessGroupProject get(String name, Output<String> id, AccessGroupProjectState state, CustomResourceOptions options)
    resources:  _:    type: vercel:AccessGroupProject    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:
    AccessGroupId string
    The ID of the Access Group.
    ProjectId string
    The Project ID to assign to the access group.
    Role string
    The project role to assign to the access group. Must be either ADMIN, PROJECT_DEVELOPER, or PROJECT_VIEWER.
    TeamId string
    The ID of the team the access group project should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    AccessGroupId string
    The ID of the Access Group.
    ProjectId string
    The Project ID to assign to the access group.
    Role string
    The project role to assign to the access group. Must be either ADMIN, PROJECT_DEVELOPER, or PROJECT_VIEWER.
    TeamId string
    The ID of the team the access group project should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    accessGroupId String
    The ID of the Access Group.
    projectId String
    The Project ID to assign to the access group.
    role String
    The project role to assign to the access group. Must be either ADMIN, PROJECT_DEVELOPER, or PROJECT_VIEWER.
    teamId String
    The ID of the team the access group project should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    accessGroupId string
    The ID of the Access Group.
    projectId string
    The Project ID to assign to the access group.
    role string
    The project role to assign to the access group. Must be either ADMIN, PROJECT_DEVELOPER, or PROJECT_VIEWER.
    teamId string
    The ID of the team the access group project should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    access_group_id str
    The ID of the Access Group.
    project_id str
    The Project ID to assign to the access group.
    role str
    The project role to assign to the access group. Must be either ADMIN, PROJECT_DEVELOPER, or PROJECT_VIEWER.
    team_id str
    The ID of the team the access group project should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    accessGroupId String
    The ID of the Access Group.
    projectId String
    The Project ID to assign to the access group.
    role String
    The project role to assign to the access group. Must be either ADMIN, PROJECT_DEVELOPER, or PROJECT_VIEWER.
    teamId String
    The ID of the team the access group project should exist under. 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, use the access_group_id and project_id.

    $ pulumi import vercel:index/accessGroupProject:AccessGroupProject example ag_xxxxxxxxxxxxxxxxxxxxxxxxxxxx/prj_xxxxxxxxxxxxxxxxxxxxxxxxxxxx

    If importing to a team, use the team_id, access_group_id and project_id.

    $ pulumi import vercel:index/accessGroupProject:AccessGroupProject example team_xxxxxxxxxxxxxxxxxxxxxxxx/ag_xxxxxxxxxxxxxxxxxxxxxxxxxxxx/prj_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.1.2 published on Tuesday, May 13, 2025 by Pulumiverse
    pulumiverse/pulumi-vercel