Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Doppler
  3. API Docs
  4. projectMember
  5. Group
Doppler v0.9.0 published on Tuesday, Aug 27, 2024 by Pulumiverse
pulumiverse/pulumi-doppler

doppler.projectMember.Group

Explore with Pulumi AI

Doppler v0.9.0 published on Tuesday, Aug 27, 2024 by Pulumiverse
pulumiverse/pulumi-doppler

Manage a Doppler project group member.

Example Usage

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

const backendEngineering = new doppler.projectmember.Group("backend_engineering", {
    project: "backend",
    groupSlug: engineering.slug,
    role: "collaborator",
    environments: [
        "dev",
        "stg",
    ],
});
Copy
import pulumi
import pulumiverse_doppler as doppler

backend_engineering = doppler.project_member.Group("backend_engineering",
    project="backend",
    group_slug=engineering["slug"],
    role="collaborator",
    environments=[
        "dev",
        "stg",
    ])
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := projectMember.NewGroup(ctx, "backend_engineering", &projectMember.GroupArgs{
			Project:   pulumi.String("backend"),
			GroupSlug: pulumi.Any(engineering.Slug),
			Role:      pulumi.String("collaborator"),
			Environments: pulumi.StringArray{
				pulumi.String("dev"),
				pulumi.String("stg"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Doppler = Pulumiverse.Doppler;

return await Deployment.RunAsync(() => 
{
    var backendEngineering = new Doppler.ProjectMember.Group("backend_engineering", new()
    {
        Project = "backend",
        GroupSlug = engineering.Slug,
        Role = "collaborator",
        Environments = new[]
        {
            "dev",
            "stg",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.doppler.projectMember.Group;
import com.pulumi.doppler.projectMember.GroupArgs;
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 backendEngineering = new Group("backendEngineering", GroupArgs.builder()
            .project("backend")
            .groupSlug(engineering.slug())
            .role("collaborator")
            .environments(            
                "dev",
                "stg")
            .build());

    }
}
Copy
resources:
  backendEngineering:
    type: doppler:projectMember:Group
    name: backend_engineering
    properties:
      project: backend
      groupSlug: ${engineering.slug}
      role: collaborator
      environments:
        - dev
        - stg
Copy

Create Group Resource

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

Constructor syntax

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

@overload
def Group(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          group_slug: Optional[str] = None,
          project: Optional[str] = None,
          role: Optional[str] = None,
          environments: Optional[Sequence[str]] = None)
func NewGroup(ctx *Context, name string, args GroupArgs, opts ...ResourceOption) (*Group, error)
public Group(string name, GroupArgs args, CustomResourceOptions? opts = null)
public Group(String name, GroupArgs args)
public Group(String name, GroupArgs args, CustomResourceOptions options)

type: doppler:projectMember:Group
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. GroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. GroupArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. GroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. GroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. GroupArgs
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 dopplerGroupResource = new Doppler.ProjectMember.Group("dopplerGroupResource", new()
{
    GroupSlug = "string",
    Project = "string",
    Role = "string",
    Environments = new[]
    {
        "string",
    },
});
Copy
example, err := projectMember.NewGroup(ctx, "dopplerGroupResource", &projectMember.GroupArgs{
	GroupSlug: pulumi.String("string"),
	Project:   pulumi.String("string"),
	Role:      pulumi.String("string"),
	Environments: pulumi.StringArray{
		pulumi.String("string"),
	},
})
Copy
var dopplerGroupResource = new Group("dopplerGroupResource", GroupArgs.builder()
    .groupSlug("string")
    .project("string")
    .role("string")
    .environments("string")
    .build());
Copy
doppler_group_resource = doppler.project_member.Group("dopplerGroupResource",
    group_slug="string",
    project="string",
    role="string",
    environments=["string"])
Copy
const dopplerGroupResource = new doppler.projectmember.Group("dopplerGroupResource", {
    groupSlug: "string",
    project: "string",
    role: "string",
    environments: ["string"],
});
Copy
type: doppler:projectMember:Group
properties:
    environments:
        - string
    groupSlug: string
    project: string
    role: string
Copy

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

GroupSlug
This property is required.
Changes to this property will trigger replacement.
string
The slug of the Doppler group
Project
This property is required.
Changes to this property will trigger replacement.
string
The name of the Doppler project where the access is applied
Role This property is required. string
The project role identifier for the access
Environments List<string>
The environments in the project where this access will apply (null or omitted for roles with access to all environments)
GroupSlug
This property is required.
Changes to this property will trigger replacement.
string
The slug of the Doppler group
Project
This property is required.
Changes to this property will trigger replacement.
string
The name of the Doppler project where the access is applied
Role This property is required. string
The project role identifier for the access
Environments []string
The environments in the project where this access will apply (null or omitted for roles with access to all environments)
groupSlug
This property is required.
Changes to this property will trigger replacement.
String
The slug of the Doppler group
project
This property is required.
Changes to this property will trigger replacement.
String
The name of the Doppler project where the access is applied
role This property is required. String
The project role identifier for the access
environments List<String>
The environments in the project where this access will apply (null or omitted for roles with access to all environments)
groupSlug
This property is required.
Changes to this property will trigger replacement.
string
The slug of the Doppler group
project
This property is required.
Changes to this property will trigger replacement.
string
The name of the Doppler project where the access is applied
role This property is required. string
The project role identifier for the access
environments string[]
The environments in the project where this access will apply (null or omitted for roles with access to all environments)
group_slug
This property is required.
Changes to this property will trigger replacement.
str
The slug of the Doppler group
project
This property is required.
Changes to this property will trigger replacement.
str
The name of the Doppler project where the access is applied
role This property is required. str
The project role identifier for the access
environments Sequence[str]
The environments in the project where this access will apply (null or omitted for roles with access to all environments)
groupSlug
This property is required.
Changes to this property will trigger replacement.
String
The slug of the Doppler group
project
This property is required.
Changes to this property will trigger replacement.
String
The name of the Doppler project where the access is applied
role This property is required. String
The project role identifier for the access
environments List<String>
The environments in the project where this access will apply (null or omitted for roles with access to all environments)

Outputs

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

Get an existing Group 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?: GroupState, opts?: CustomResourceOptions): Group
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        environments: Optional[Sequence[str]] = None,
        group_slug: Optional[str] = None,
        project: Optional[str] = None,
        role: Optional[str] = None) -> Group
func GetGroup(ctx *Context, name string, id IDInput, state *GroupState, opts ...ResourceOption) (*Group, error)
public static Group Get(string name, Input<string> id, GroupState? state, CustomResourceOptions? opts = null)
public static Group get(String name, Output<String> id, GroupState state, CustomResourceOptions options)
resources:  _:    type: doppler:projectMember:Group    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Environments List<string>
The environments in the project where this access will apply (null or omitted for roles with access to all environments)
GroupSlug Changes to this property will trigger replacement. string
The slug of the Doppler group
Project Changes to this property will trigger replacement. string
The name of the Doppler project where the access is applied
Role string
The project role identifier for the access
Environments []string
The environments in the project where this access will apply (null or omitted for roles with access to all environments)
GroupSlug Changes to this property will trigger replacement. string
The slug of the Doppler group
Project Changes to this property will trigger replacement. string
The name of the Doppler project where the access is applied
Role string
The project role identifier for the access
environments List<String>
The environments in the project where this access will apply (null or omitted for roles with access to all environments)
groupSlug Changes to this property will trigger replacement. String
The slug of the Doppler group
project Changes to this property will trigger replacement. String
The name of the Doppler project where the access is applied
role String
The project role identifier for the access
environments string[]
The environments in the project where this access will apply (null or omitted for roles with access to all environments)
groupSlug Changes to this property will trigger replacement. string
The slug of the Doppler group
project Changes to this property will trigger replacement. string
The name of the Doppler project where the access is applied
role string
The project role identifier for the access
environments Sequence[str]
The environments in the project where this access will apply (null or omitted for roles with access to all environments)
group_slug Changes to this property will trigger replacement. str
The slug of the Doppler group
project Changes to this property will trigger replacement. str
The name of the Doppler project where the access is applied
role str
The project role identifier for the access
environments List<String>
The environments in the project where this access will apply (null or omitted for roles with access to all environments)
groupSlug Changes to this property will trigger replacement. String
The slug of the Doppler group
project Changes to this property will trigger replacement. String
The name of the Doppler project where the access is applied
role String
The project role identifier for the access

Package Details

Repository
doppler pulumiverse/pulumi-doppler
License
Apache-2.0
Notes
This Pulumi package is based on the doppler Terraform Provider.
Doppler v0.9.0 published on Tuesday, Aug 27, 2024 by Pulumiverse
pulumiverse/pulumi-doppler