Skip to content

pulumi/pulumi-pulumiservice

Pulumi Service Provider

Slack NPM version Python version NuGet version PkgGoDev License

Pulumi Service Provider for creating Pulumi Cloud resources.

The Pulumi Service Provider (PSP) is built on top of the Pulumi Cloud REST API, allowing Pulumi customers to create Pulumi Cloud resources using Pulumi programs. That includes Stacks, Environments, Teams, Tokens, Webhooks, Tags, Deployment Settings, Deployment Schedules and much more! Pulumi Service Provider is especially powerful when used in combination with the Automation API.

For a full list of supported resources, visit the Pulumi Registry. For the REST API reference documentation, visit Pulumi Cloud API Documentation.

For now, PSP is in public preview, but we're working on releasing v1.0 in the near future.

Installing

This package is available in many languages in the standard packaging formats.

Node.js (Java/TypeScript)

To use from JavaScript or TypeScript in Node.js, install using either npm:

$ npm install @pulumi/pulumiservice

or yarn:

$ yarn add @pulumi/pulumiservice

Python

To use from Python, install using pip:

$ pip install pulumi_pulumiservice

Go

To use from Go, use go get to grab the latest version of the library

$ go get github.com/pulumi/pulumi-pulumiservice/sdk/go

.NET

To use from .NET, install using dotnet add package:

$ dotnet add package Pulumi.PulumiService

Java

To use from Java, add an entry to your build.gradle file:

$ implementation 'com.pulumi:pulumiservice:%Fill in latest version from the badge up top%'

Or to your pom.xml file:

$   <dependency>
$       <groupId>com.pulumi</groupId>
$       <artifactId>pulumiservice</artifactId>
$       <version>%Fill in latest version from the badge up top%</version>
$   </dependency>

Setup

Ensure that you have ran pulumi login. Run pulumi whoami to verify that you are logged in.

Configuration Options

Use pulumi config set pulumiservice:<option> or pass options to the [constructor of new pulumiservice.Provider][1].

Option Environment Variable Name Required/Optional Description
accessToken PULUMI_ACCESS_TOKEN Optional Overrides [Pulumi Service Access Tokens][2]
apiUrl PULUMI_BACKEND_URL Optional Allows overriding default [Pulumi Service API URL][3] for [self hosted customers][4].

Examples

import * as aws from "@pulumi/awsx"
import * as pulumi from "@pulumi/pulumi";
import * as service from "@pulumi/pulumiservice";

const team = new service.Team("team", {
    name: "pulumi-service-team",
    displayName: "Pulumi Service",
    description: "The Pulumi Service Team",
    organizationName: "pulumi",
    teamType: "pulumi",
    members: [
        "piers",
        "bryce",
        "casey"
        "evan",
        "devon",
        "meagan"
        "myles",
        "steve"
    ],
});

export const members = team.members;

Check out the examples/ directory for more examples.