1. Packages
  2. Doppler
  3. API Docs
  4. ServiceToken
Doppler v0.9.0 published on Tuesday, Aug 27, 2024 by Pulumiverse

doppler.ServiceToken

Explore with Pulumi AI

Manage a Doppler service token.

Example Usage

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

const backendCiToken = new doppler.ServiceToken("backend_ci_token", {
    project: "backend",
    config: "ci",
    name: "Builder Token",
    access: "read",
});
Copy
import pulumi
import pulumiverse_doppler as doppler

backend_ci_token = doppler.ServiceToken("backend_ci_token",
    project="backend",
    config="ci",
    name="Builder Token",
    access="read")
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.NewServiceToken(ctx, "backend_ci_token", &doppler.ServiceTokenArgs{
			Project: pulumi.String("backend"),
			Config:  pulumi.String("ci"),
			Name:    pulumi.String("Builder Token"),
			Access:  pulumi.String("read"),
		})
		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 backendCiToken = new Doppler.ServiceToken("backend_ci_token", new()
    {
        Project = "backend",
        Config = "ci",
        Name = "Builder Token",
        Access = "read",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.doppler.ServiceToken;
import com.pulumi.doppler.ServiceTokenArgs;
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 backendCiToken = new ServiceToken("backendCiToken", ServiceTokenArgs.builder()
            .project("backend")
            .config("ci")
            .name("Builder Token")
            .access("read")
            .build());

    }
}
Copy
resources:
  backendCiToken:
    type: doppler:ServiceToken
    name: backend_ci_token
    properties:
      project: backend
      config: ci
      name: Builder Token
      access: read
Copy

Create ServiceToken Resource

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

Constructor syntax

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

@overload
def ServiceToken(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 config: Optional[str] = None,
                 name: Optional[str] = None,
                 project: Optional[str] = None,
                 access: Optional[str] = None)
func NewServiceToken(ctx *Context, name string, args ServiceTokenArgs, opts ...ResourceOption) (*ServiceToken, error)
public ServiceToken(string name, ServiceTokenArgs args, CustomResourceOptions? opts = null)
public ServiceToken(String name, ServiceTokenArgs args)
public ServiceToken(String name, ServiceTokenArgs args, CustomResourceOptions options)
type: doppler:ServiceToken
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. ServiceTokenArgs
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. ServiceTokenArgs
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. ServiceTokenArgs
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. ServiceTokenArgs
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. ServiceTokenArgs
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 serviceTokenResource = new Doppler.ServiceToken("serviceTokenResource", new()
{
    Config = "string",
    Name = "string",
    Project = "string",
    Access = "string",
});
Copy
example, err := doppler.NewServiceToken(ctx, "serviceTokenResource", &doppler.ServiceTokenArgs{
	Config:  pulumi.String("string"),
	Name:    pulumi.String("string"),
	Project: pulumi.String("string"),
	Access:  pulumi.String("string"),
})
Copy
var serviceTokenResource = new ServiceToken("serviceTokenResource", ServiceTokenArgs.builder()
    .config("string")
    .name("string")
    .project("string")
    .access("string")
    .build());
Copy
service_token_resource = doppler.ServiceToken("serviceTokenResource",
    config="string",
    name="string",
    project="string",
    access="string")
Copy
const serviceTokenResource = new doppler.ServiceToken("serviceTokenResource", {
    config: "string",
    name: "string",
    project: "string",
    access: "string",
});
Copy
type: doppler:ServiceToken
properties:
    access: string
    config: string
    name: string
    project: string
Copy

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

Config
This property is required.
Changes to this property will trigger replacement.
string
The name of the Doppler config where the service token is located
Name
This property is required.
Changes to this property will trigger replacement.
string
The name of the Doppler service token
Project
This property is required.
Changes to this property will trigger replacement.
string
The name of the Doppler project where the service token is located
Access Changes to this property will trigger replacement. string
The access level (read or read/write)
Config
This property is required.
Changes to this property will trigger replacement.
string
The name of the Doppler config where the service token is located
Name
This property is required.
Changes to this property will trigger replacement.
string
The name of the Doppler service token
Project
This property is required.
Changes to this property will trigger replacement.
string
The name of the Doppler project where the service token is located
Access Changes to this property will trigger replacement. string
The access level (read or read/write)
config
This property is required.
Changes to this property will trigger replacement.
String
The name of the Doppler config where the service token is located
name
This property is required.
Changes to this property will trigger replacement.
String
The name of the Doppler service token
project
This property is required.
Changes to this property will trigger replacement.
String
The name of the Doppler project where the service token is located
access Changes to this property will trigger replacement. String
The access level (read or read/write)
config
This property is required.
Changes to this property will trigger replacement.
string
The name of the Doppler config where the service token is located
name
This property is required.
Changes to this property will trigger replacement.
string
The name of the Doppler service token
project
This property is required.
Changes to this property will trigger replacement.
string
The name of the Doppler project where the service token is located
access Changes to this property will trigger replacement. string
The access level (read or read/write)
config
This property is required.
Changes to this property will trigger replacement.
str
The name of the Doppler config where the service token is located
name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Doppler service token
project
This property is required.
Changes to this property will trigger replacement.
str
The name of the Doppler project where the service token is located
access Changes to this property will trigger replacement. str
The access level (read or read/write)
config
This property is required.
Changes to this property will trigger replacement.
String
The name of the Doppler config where the service token is located
name
This property is required.
Changes to this property will trigger replacement.
String
The name of the Doppler service token
project
This property is required.
Changes to this property will trigger replacement.
String
The name of the Doppler project where the service token is located
access Changes to this property will trigger replacement. String
The access level (read or read/write)

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Key string
The key for the Doppler service token
Id string
The provider-assigned unique ID for this managed resource.
Key string
The key for the Doppler service token
id String
The provider-assigned unique ID for this managed resource.
key String
The key for the Doppler service token
id string
The provider-assigned unique ID for this managed resource.
key string
The key for the Doppler service token
id str
The provider-assigned unique ID for this managed resource.
key str
The key for the Doppler service token
id String
The provider-assigned unique ID for this managed resource.
key String
The key for the Doppler service token

Look up Existing ServiceToken Resource

Get an existing ServiceToken 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?: ServiceTokenState, opts?: CustomResourceOptions): ServiceToken
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access: Optional[str] = None,
        config: Optional[str] = None,
        key: Optional[str] = None,
        name: Optional[str] = None,
        project: Optional[str] = None) -> ServiceToken
func GetServiceToken(ctx *Context, name string, id IDInput, state *ServiceTokenState, opts ...ResourceOption) (*ServiceToken, error)
public static ServiceToken Get(string name, Input<string> id, ServiceTokenState? state, CustomResourceOptions? opts = null)
public static ServiceToken get(String name, Output<String> id, ServiceTokenState state, CustomResourceOptions options)
resources:  _:    type: doppler:ServiceToken    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:
Access Changes to this property will trigger replacement. string
The access level (read or read/write)
Config Changes to this property will trigger replacement. string
The name of the Doppler config where the service token is located
Key string
The key for the Doppler service token
Name Changes to this property will trigger replacement. string
The name of the Doppler service token
Project Changes to this property will trigger replacement. string
The name of the Doppler project where the service token is located
Access Changes to this property will trigger replacement. string
The access level (read or read/write)
Config Changes to this property will trigger replacement. string
The name of the Doppler config where the service token is located
Key string
The key for the Doppler service token
Name Changes to this property will trigger replacement. string
The name of the Doppler service token
Project Changes to this property will trigger replacement. string
The name of the Doppler project where the service token is located
access Changes to this property will trigger replacement. String
The access level (read or read/write)
config Changes to this property will trigger replacement. String
The name of the Doppler config where the service token is located
key String
The key for the Doppler service token
name Changes to this property will trigger replacement. String
The name of the Doppler service token
project Changes to this property will trigger replacement. String
The name of the Doppler project where the service token is located
access Changes to this property will trigger replacement. string
The access level (read or read/write)
config Changes to this property will trigger replacement. string
The name of the Doppler config where the service token is located
key string
The key for the Doppler service token
name Changes to this property will trigger replacement. string
The name of the Doppler service token
project Changes to this property will trigger replacement. string
The name of the Doppler project where the service token is located
access Changes to this property will trigger replacement. str
The access level (read or read/write)
config Changes to this property will trigger replacement. str
The name of the Doppler config where the service token is located
key str
The key for the Doppler service token
name Changes to this property will trigger replacement. str
The name of the Doppler service token
project Changes to this property will trigger replacement. str
The name of the Doppler project where the service token is located
access Changes to this property will trigger replacement. String
The access level (read or read/write)
config Changes to this property will trigger replacement. String
The name of the Doppler config where the service token is located
key String
The key for the Doppler service token
name Changes to this property will trigger replacement. String
The name of the Doppler service token
project Changes to this property will trigger replacement. String
The name of the Doppler project where the service token is located

Package Details

Repository
doppler pulumiverse/pulumi-doppler
License
Apache-2.0
Notes
This Pulumi package is based on the doppler Terraform Provider.