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

doppler.Group

Explore with Pulumi AI

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

Manage a Doppler group.

Example Usage

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

const engineering = new doppler.Group("engineering", {name: "engineering"});
Copy
import pulumi
import pulumiverse_doppler as doppler

engineering = doppler.Group("engineering", name="engineering")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := doppler.NewGroup(ctx, "engineering", &doppler.GroupArgs{
			Name: pulumi.String("engineering"),
		})
		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 engineering = new Doppler.Group("engineering", new()
    {
        Name = "engineering",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.doppler.Group;
import com.pulumi.doppler.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 engineering = new Group("engineering", GroupArgs.builder()
            .name("engineering")
            .build());

    }
}
Copy
resources:
  engineering:
    type: doppler:Group
    properties:
      name: engineering
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,
          name: Optional[str] = None,
          default_project_role: Optional[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: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 groupResource = new Doppler.Group("groupResource", new()
{
    Name = "string",
    DefaultProjectRole = "string",
});
Copy
example, err := doppler.NewGroup(ctx, "groupResource", &doppler.GroupArgs{
	Name:               pulumi.String("string"),
	DefaultProjectRole: pulumi.String("string"),
})
Copy
var groupResource = new Group("groupResource", GroupArgs.builder()
    .name("string")
    .defaultProjectRole("string")
    .build());
Copy
group_resource = doppler.Group("groupResource",
    name="string",
    default_project_role="string")
Copy
const groupResource = new doppler.Group("groupResource", {
    name: "string",
    defaultProjectRole: "string",
});
Copy
type: doppler:Group
properties:
    defaultProjectRole: string
    name: 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:

Name This property is required. string
The name of the group
DefaultProjectRole string
The default project role assigned to the group when added to a Doppler project
Name This property is required. string
The name of the group
DefaultProjectRole string
The default project role assigned to the group when added to a Doppler project
name This property is required. String
The name of the group
defaultProjectRole String
The default project role assigned to the group when added to a Doppler project
name This property is required. string
The name of the group
defaultProjectRole string
The default project role assigned to the group when added to a Doppler project
name This property is required. str
The name of the group
default_project_role str
The default project role assigned to the group when added to a Doppler project
name This property is required. String
The name of the group
defaultProjectRole String
The default project role assigned to the group when added to a Doppler project

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.
Slug string
The slug of the group
Id string
The provider-assigned unique ID for this managed resource.
Slug string
The slug of the group
id String
The provider-assigned unique ID for this managed resource.
slug String
The slug of the group
id string
The provider-assigned unique ID for this managed resource.
slug string
The slug of the group
id str
The provider-assigned unique ID for this managed resource.
slug str
The slug of the group
id String
The provider-assigned unique ID for this managed resource.
slug String
The slug of the group

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,
        default_project_role: Optional[str] = None,
        name: Optional[str] = None,
        slug: 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: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:
DefaultProjectRole string
The default project role assigned to the group when added to a Doppler project
Name string
The name of the group
Slug string
The slug of the group
DefaultProjectRole string
The default project role assigned to the group when added to a Doppler project
Name string
The name of the group
Slug string
The slug of the group
defaultProjectRole String
The default project role assigned to the group when added to a Doppler project
name String
The name of the group
slug String
The slug of the group
defaultProjectRole string
The default project role assigned to the group when added to a Doppler project
name string
The name of the group
slug string
The slug of the group
default_project_role str
The default project role assigned to the group when added to a Doppler project
name str
The name of the group
slug str
The slug of the group
defaultProjectRole String
The default project role assigned to the group when added to a Doppler project
name String
The name of the group
slug String
The slug of the group

Import

import using the group slug from the URL:

https://dashboard.doppler.com/workplace/[workplace-slug]/team/groups/[group-slug]

$ pulumi import doppler:index/group:Group default <group-slug>
Copy

To learn more about importing existing cloud resources, see Importing resources.

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