Docs Packages
  1. Packages
  2. MongoDB Atlas
  3. API Docs
  4. Teams
MongoDB Atlas v3.16.2 published on Friday, Jun 21, 2024 by Pulumi
pulumi/pulumi-mongodbatlas

mongodbatlas.Teams

Explore with Pulumi AI

mongodbatlas logo
MongoDB Atlas v3.16.2 published on Friday, Jun 21, 2024 by Pulumi
pulumi/pulumi-mongodbatlas

    This resource is deprecated. Please transition to using mongodbatlas.Team which defines the same underlying implementation, aligning the name of the resource with the implementation which manages a single team.

    Create Teams Resource

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

    Constructor syntax

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

@overload
def Teams(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          org_id: Optional[str] = None,
          usernames: Optional[Sequence[str]] = None,
          name: Optional[str] = None)
    func NewTeams(ctx *Context, name string, args TeamsArgs, opts ...ResourceOption) (*Teams, error)
    public Teams(string name, TeamsArgs args, CustomResourceOptions? opts = null)
    public Teams(String name, TeamsArgs args)
public Teams(String name, TeamsArgs args, CustomResourceOptions options)

    type: mongodbatlas:Teams
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 TeamsArgs
    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 TeamsArgs
    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 TeamsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TeamsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TeamsArgs
    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 teamsResource = new Mongodbatlas.Teams("teamsResource", new()
{
    OrgId = "string",
    Usernames = new[]
    {
        "string",
    },
    Name = "string",
});

    example, err := mongodbatlas.NewTeams(ctx, "teamsResource", &mongodbatlas.TeamsArgs{
	OrgId: pulumi.String("string"),
	Usernames: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name: pulumi.String("string"),
})

    var teamsResource = new Teams("teamsResource", TeamsArgs.builder()
    .orgId("string")
    .usernames("string")
    .name("string")
    .build());

    teams_resource = mongodbatlas.Teams("teamsResource",
    org_id="string",
    usernames=["string"],
    name="string")

    const teamsResource = new mongodbatlas.Teams("teamsResource", {
    orgId: "string",
    usernames: ["string"],
    name: "string",
});

    type: mongodbatlas:Teams
properties:
    name: string
    orgId: string
    usernames:
        - string

    Teams Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Teams resource accepts the following input properties:

    OrgId string
    Usernames List<string>
    Name string
    OrgId string
    Usernames []string
    Name string
    orgId String
    usernames List<String>
    name String
    orgId string
    usernames string[]
    name string
    org_id str
    usernames Sequence[str]
    name str
    orgId String
    usernames List<String>
    name String

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Teams resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    TeamId string
    Id string
    The provider-assigned unique ID for this managed resource.
    TeamId string
    id String
    The provider-assigned unique ID for this managed resource.
    teamId String
    id string
    The provider-assigned unique ID for this managed resource.
    teamId string
    id str
    The provider-assigned unique ID for this managed resource.
    team_id str
    id String
    The provider-assigned unique ID for this managed resource.
    teamId String

    Look up Existing Teams Resource

    Get an existing Teams 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?: TeamsState, opts?: CustomResourceOptions): Teams
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        name: Optional[str] = None,
        org_id: Optional[str] = None,
        team_id: Optional[str] = None,
        usernames: Optional[Sequence[str]] = None) -> Teams
    func GetTeams(ctx *Context, name string, id IDInput, state *TeamsState, opts ...ResourceOption) (*Teams, error)
    public static Teams Get(string name, Input<string> id, TeamsState? state, CustomResourceOptions? opts = null)
    public static Teams get(String name, Output<String> id, TeamsState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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
    OrgId string
    TeamId string
    Usernames List<string>
    Name string
    OrgId string
    TeamId string
    Usernames []string
    name String
    orgId String
    teamId String
    usernames List<String>
    name string
    orgId string
    teamId string
    usernames string[]
    name str
    org_id str
    team_id str
    usernames Sequence[str]
    name String
    orgId String
    teamId String
    usernames List<String>

    Package Details

    Repository
    MongoDB Atlas pulumi/pulumi-mongodbatlas
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the mongodbatlas Terraform Provider.
    mongodbatlas logo
    MongoDB Atlas v3.16.2 published on Friday, Jun 21, 2024 by Pulumi
    pulumi/pulumi-mongodbatlas