← All packages

Tailscale

Pulumi Official

Package maintained by Pulumi

v0.8.0 published on Monday, May 16, 2022 by Pulumi

Source code

DeviceKey

The device_key resource allows you to modify the property of a device’s key.

Example Usage

using Pulumi;
using Tailscale = Pulumi.Tailscale;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleDevice = Output.Create(Tailscale.GetDevice.InvokeAsync(new Tailscale.GetDeviceArgs
        {
            Name = "device.example.com",
        }));
        var exampleKey = new Tailscale.DeviceKey("exampleKey", new Tailscale.DeviceKeyArgs
        {
            DeviceId = exampleDevice.Apply(exampleDevice => exampleDevice.Id),
            Preauthorized = true,
            KeyExpiryDisabled = true,
        });
    }

}

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleDevice, err := tailscale.GetDevice(ctx, &GetDeviceArgs{
			Name: "device.example.com",
		}, nil)
		if err != nil {
			return err
		}
		_, err = tailscale.NewDeviceKey(ctx, "exampleKey", &tailscale.DeviceKeyArgs{
			DeviceId:          pulumi.String(exampleDevice.Id),
			Preauthorized:     pulumi.Bool(true),
			KeyExpiryDisabled: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_tailscale as tailscale

example_device = tailscale.get_device(name="device.example.com")
example_key = tailscale.DeviceKey("exampleKey",
    device_id=example_device.id,
    preauthorized=True,
    key_expiry_disabled=True)

import * as pulumi from "@pulumi/pulumi";
import * as tailscale from "@pulumi/tailscale";

const exampleDevice = tailscale.getDevice({
    name: "device.example.com",
});
const exampleKey = new tailscale.DeviceKey("exampleKey", {
    deviceId: exampleDevice.then(exampleDevice => exampleDevice.id),
    preauthorized: true,
    keyExpiryDisabled: true,
});

Coming soon!

Create a DeviceKey Resource

new DeviceKey(name: string, args: DeviceKeyArgs, opts?: CustomResourceOptions);

@overload
def DeviceKey(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              device_id: Optional[str] = None,
              key_expiry_disabled: Optional[bool] = None,
              preauthorized: Optional[bool] = None)
@overload
def DeviceKey(resource_name: str,
              args: DeviceKeyArgs,
              opts: Optional[ResourceOptions] = None)

func NewDeviceKey(ctx *Context, name string, args DeviceKeyArgs, opts ...ResourceOption) (*DeviceKey, error)

public DeviceKey(string name, DeviceKeyArgs args, CustomResourceOptions? opts = null)

public DeviceKey(String name, DeviceKeyArgs args)
public DeviceKey(String name, DeviceKeyArgs args, CustomResourceOptions options)

type: tailscale:DeviceKey
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args DeviceKeyArgs: 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 DeviceKeyArgs: 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 DeviceKeyArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args DeviceKeyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args DeviceKeyArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

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

DeviceId string: The device to change the key properties of.
KeyExpiryDisabled bool: Whether the device's key will ever expire.
Preauthorized bool: Whether the device should be authorized for the tailnet by default, works in tailnets where device authorization is enabled.

DeviceId string: The device to change the key properties of.
KeyExpiryDisabled bool: Whether the device's key will ever expire.
Preauthorized bool: Whether the device should be authorized for the tailnet by default, works in tailnets where device authorization is enabled.

deviceId String: The device to change the key properties of.
keyExpiryDisabled Boolean: Whether the device's key will ever expire.
preauthorized Boolean: Whether the device should be authorized for the tailnet by default, works in tailnets where device authorization is enabled.

deviceId string: The device to change the key properties of.
keyExpiryDisabled boolean: Whether the device's key will ever expire.
preauthorized boolean: Whether the device should be authorized for the tailnet by default, works in tailnets where device authorization is enabled.

device_id str: The device to change the key properties of.
key_expiry_disabled bool: Whether the device's key will ever expire.
preauthorized bool: Whether the device should be authorized for the tailnet by default, works in tailnets where device authorization is enabled.

deviceId String: The device to change the key properties of.
keyExpiryDisabled Boolean: Whether the device's key will ever expire.
preauthorized Boolean: Whether the device should be authorized for the tailnet by default, works in tailnets where device authorization is enabled.

Outputs

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

Get an existing DeviceKey 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?: DeviceKeyState, opts?: CustomResourceOptions): DeviceKey

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        device_id: Optional[str] = None,
        key_expiry_disabled: Optional[bool] = None,
        preauthorized: Optional[bool] = None) -> DeviceKey

func GetDeviceKey(ctx *Context, name string, id IDInput, state *DeviceKeyState, opts ...ResourceOption) (*DeviceKey, error)

public static DeviceKey Get(string name, Input<string> id, DeviceKeyState? state, CustomResourceOptions? opts = null)

public static DeviceKey get(String name, Output<String> id, DeviceKeyState 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:

DeviceId string: The device to change the key properties of.
KeyExpiryDisabled bool: Whether the device's key will ever expire.
Preauthorized bool: Whether the device should be authorized for the tailnet by default, works in tailnets where device authorization is enabled.

DeviceId string: The device to change the key properties of.
KeyExpiryDisabled bool: Whether the device's key will ever expire.
Preauthorized bool: Whether the device should be authorized for the tailnet by default, works in tailnets where device authorization is enabled.

deviceId String: The device to change the key properties of.
keyExpiryDisabled Boolean: Whether the device's key will ever expire.
preauthorized Boolean: Whether the device should be authorized for the tailnet by default, works in tailnets where device authorization is enabled.

deviceId string: The device to change the key properties of.
keyExpiryDisabled boolean: Whether the device's key will ever expire.
preauthorized boolean: Whether the device should be authorized for the tailnet by default, works in tailnets where device authorization is enabled.

device_id str: The device to change the key properties of.
key_expiry_disabled bool: Whether the device's key will ever expire.
preauthorized bool: Whether the device should be authorized for the tailnet by default, works in tailnets where device authorization is enabled.

deviceId String: The device to change the key properties of.
keyExpiryDisabled Boolean: Whether the device's key will ever expire.
preauthorized Boolean: Whether the device should be authorized for the tailnet by default, works in tailnets where device authorization is enabled.

Package Details

Repository: https://github.com/pulumi/pulumi-tailscale
License: Apache-2.0
Notes: This Pulumi package is based on the tailscale Terraform Provider.