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

vercel.AccessGroup

Explore with Pulumi AI

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

    Provides an Access Group Resource.

    Access Groups provide a way to manage groups of Vercel users across projects on your team. They are a set of project role assignations, a combination of Vercel users and the projects they work on.

    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.AccessGroup("example", {name: "example-access-group"});

    import pulumi
import pulumiverse_vercel as vercel

example = vercel.AccessGroup("example", name="example-access-group")

    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 {
		_, err := vercel.NewAccessGroup(ctx, "example", &vercel.AccessGroupArgs{
			Name: pulumi.String("example-access-group"),
		})
		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.AccessGroup("example", new()
    {
        Name = "example-access-group",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vercel.AccessGroup;
import com.pulumi.vercel.AccessGroupArgs;
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 AccessGroup("example", AccessGroupArgs.builder()
            .name("example-access-group")
            .build());

    }
}

    resources:
  example:
    type: vercel:AccessGroup
    properties:
      name: example-access-group

    Create AccessGroup Resource

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

    Constructor syntax

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

@overload
def AccessGroup(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                name: Optional[str] = None,
                team_id: Optional[str] = None)
    func NewAccessGroup(ctx *Context, name string, args *AccessGroupArgs, opts ...ResourceOption) (*AccessGroup, error)
    public AccessGroup(string name, AccessGroupArgs? args = null, CustomResourceOptions? opts = null)
    public AccessGroup(String name, AccessGroupArgs args)
public AccessGroup(String name, AccessGroupArgs args, CustomResourceOptions options)

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

    example, err := vercel.NewAccessGroup(ctx, "accessGroupResource", &vercel.AccessGroupArgs{
	Name:   pulumi.String("string"),
	TeamId: pulumi.String("string"),
})

    var accessGroupResource = new AccessGroup("accessGroupResource", AccessGroupArgs.builder()
    .name("string")
    .teamId("string")
    .build());

    access_group_resource = vercel.AccessGroup("accessGroupResource",
    name="string",
    team_id="string")

    const accessGroupResource = new vercel.AccessGroup("accessGroupResource", {
    name: "string",
    teamId: "string",
});

    type: vercel:AccessGroup
properties:
    name: string
    teamId: string

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

    Name string
    The name of the Access Group
    TeamId string
    The ID of the team the Access Group should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    Name string
    The name of the Access Group
    TeamId string
    The ID of the team the Access Group should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    name String
    The name of the Access Group
    teamId String
    The ID of the team the Access Group should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    name string
    The name of the Access Group
    teamId string
    The ID of the team the Access Group should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    name str
    The name of the Access Group
    team_id str
    The ID of the team the Access Group should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    name String
    The name of the Access Group
    teamId String
    The ID of the team the Access Group 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 AccessGroup 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 AccessGroup Resource

    Get an existing AccessGroup 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?: AccessGroupState, opts?: CustomResourceOptions): AccessGroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        name: Optional[str] = None,
        team_id: Optional[str] = None) -> AccessGroup
    func GetAccessGroup(ctx *Context, name string, id IDInput, state *AccessGroupState, opts ...ResourceOption) (*AccessGroup, error)
    public static AccessGroup Get(string name, Input<string> id, AccessGroupState? state, CustomResourceOptions? opts = null)
    public static AccessGroup get(String name, Output<String> id, AccessGroupState state, CustomResourceOptions options)
    resources:  _:    type: vercel:AccessGroup    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:
    Name string
    The name of the Access Group
    TeamId string
    The ID of the team the Access Group should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    Name string
    The name of the Access Group
    TeamId string
    The ID of the team the Access Group should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    name String
    The name of the Access Group
    teamId String
    The ID of the team the Access Group should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    name string
    The name of the Access Group
    teamId string
    The ID of the team the Access Group should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    name str
    The name of the Access Group
    team_id str
    The ID of the team the Access Group should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    name String
    The name of the Access Group
    teamId String
    The ID of the team the Access Group 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, simply use the access_group_id.

    $ pulumi import vercel:index/accessGroup:AccessGroup example ag_xxxxxxxxxxxxxxxxxxxxxxxxxxxx

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

    $ pulumi import vercel:index/accessGroup:AccessGroup example team_xxxxxxxxxxxxxxxxxxxxxxxx/ag_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