Tailscale v0.15.0 published on Saturday, Mar 2, 2024 by Pulumi
tailscale.TailnetKey
Explore with Pulumi AI
The tailnet_key resource allows you to create pre-authentication keys that can register new nodes without needing to sign in via a web browser. See https://tailscale.com/kb/1085/auth-keys for more information
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Tailscale = Pulumi.Tailscale;
return await Deployment.RunAsync(() =>
{
var sampleKey = new Tailscale.TailnetKey("sampleKey", new()
{
Description = "Sample key",
Ephemeral = false,
Expiry = 3600,
Preauthorized = true,
Reusable = 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 {
_, err := tailscale.NewTailnetKey(ctx, "sampleKey", &tailscale.TailnetKeyArgs{
Description: pulumi.String("Sample key"),
Ephemeral: pulumi.Bool(false),
Expiry: pulumi.Int(3600),
Preauthorized: pulumi.Bool(true),
Reusable: pulumi.Bool(true),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tailscale.TailnetKey;
import com.pulumi.tailscale.TailnetKeyArgs;
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 sampleKey = new TailnetKey("sampleKey", TailnetKeyArgs.builder()
.description("Sample key")
.ephemeral(false)
.expiry(3600)
.preauthorized(true)
.reusable(true)
.build());
}
}
import pulumi
import pulumi_tailscale as tailscale
sample_key = tailscale.TailnetKey("sampleKey",
description="Sample key",
ephemeral=False,
expiry=3600,
preauthorized=True,
reusable=True)
import * as pulumi from "@pulumi/pulumi";
import * as tailscale from "@pulumi/tailscale";
const sampleKey = new tailscale.TailnetKey("sampleKey", {
description: "Sample key",
ephemeral: false,
expiry: 3600,
preauthorized: true,
reusable: true,
});
resources:
sampleKey:
type: tailscale:TailnetKey
properties:
description: Sample key
ephemeral: false
expiry: 3600
preauthorized: true
reusable: true
Create TailnetKey Resource
new TailnetKey(name: string, args?: TailnetKeyArgs, opts?: CustomResourceOptions);
@overload
def TailnetKey(resource_name: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
ephemeral: Optional[bool] = None,
expiry: Optional[int] = None,
preauthorized: Optional[bool] = None,
recreate_if_invalid: Optional[str] = None,
reusable: Optional[bool] = None,
tags: Optional[Sequence[str]] = None)
@overload
def TailnetKey(resource_name: str,
args: Optional[TailnetKeyArgs] = None,
opts: Optional[ResourceOptions] = None)
func NewTailnetKey(ctx *Context, name string, args *TailnetKeyArgs, opts ...ResourceOption) (*TailnetKey, error)
public TailnetKey(string name, TailnetKeyArgs? args = null, CustomResourceOptions? opts = null)
public TailnetKey(String name, TailnetKeyArgs args)
public TailnetKey(String name, TailnetKeyArgs args, CustomResourceOptions options)
type: tailscale:TailnetKey
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args TailnetKeyArgs
- 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 TailnetKeyArgs
- 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 TailnetKeyArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args TailnetKeyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args TailnetKeyArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
TailnetKey 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 TailnetKey resource accepts the following input properties:
- Description string
- A description of the key consisting of alphanumeric characters. Defaults to
""
. - Ephemeral bool
- Indicates if the key is ephemeral. Defaults to
false
. - Expiry int
- The expiry of the key in seconds. Defaults to
7776000
(90 days). - bool
- Determines whether or not the machines authenticated by the key will be authorized for the tailnet by default. Defaults to
false
. - Recreate
If stringInvalid - Determines whether the key should be created again if it becomes invalid. By default, reusable keys will be recreated, but single-use keys will not. Possible values: 'always', 'never'.
- Reusable bool
- Indicates if the key is reusable or single-use. Defaults to
false
. - List<string>
- List of tags to apply to the machines authenticated by the key.
- Description string
- A description of the key consisting of alphanumeric characters. Defaults to
""
. - Ephemeral bool
- Indicates if the key is ephemeral. Defaults to
false
. - Expiry int
- The expiry of the key in seconds. Defaults to
7776000
(90 days). - bool
- Determines whether or not the machines authenticated by the key will be authorized for the tailnet by default. Defaults to
false
. - Recreate
If stringInvalid - Determines whether the key should be created again if it becomes invalid. By default, reusable keys will be recreated, but single-use keys will not. Possible values: 'always', 'never'.
- Reusable bool
- Indicates if the key is reusable or single-use. Defaults to
false
. - []string
- List of tags to apply to the machines authenticated by the key.
- description String
- A description of the key consisting of alphanumeric characters. Defaults to
""
. - ephemeral Boolean
- Indicates if the key is ephemeral. Defaults to
false
. - expiry Integer
- The expiry of the key in seconds. Defaults to
7776000
(90 days). - Boolean
- Determines whether or not the machines authenticated by the key will be authorized for the tailnet by default. Defaults to
false
. - recreate
If StringInvalid - Determines whether the key should be created again if it becomes invalid. By default, reusable keys will be recreated, but single-use keys will not. Possible values: 'always', 'never'.
- reusable Boolean
- Indicates if the key is reusable or single-use. Defaults to
false
. - List<String>
- List of tags to apply to the machines authenticated by the key.
- description string
- A description of the key consisting of alphanumeric characters. Defaults to
""
. - ephemeral boolean
- Indicates if the key is ephemeral. Defaults to
false
. - expiry number
- The expiry of the key in seconds. Defaults to
7776000
(90 days). - boolean
- Determines whether or not the machines authenticated by the key will be authorized for the tailnet by default. Defaults to
false
. - recreate
If stringInvalid - Determines whether the key should be created again if it becomes invalid. By default, reusable keys will be recreated, but single-use keys will not. Possible values: 'always', 'never'.
- reusable boolean
- Indicates if the key is reusable or single-use. Defaults to
false
. - string[]
- List of tags to apply to the machines authenticated by the key.
- description str
- A description of the key consisting of alphanumeric characters. Defaults to
""
. - ephemeral bool
- Indicates if the key is ephemeral. Defaults to
false
. - expiry int
- The expiry of the key in seconds. Defaults to
7776000
(90 days). - bool
- Determines whether or not the machines authenticated by the key will be authorized for the tailnet by default. Defaults to
false
. - recreate_
if_ strinvalid - Determines whether the key should be created again if it becomes invalid. By default, reusable keys will be recreated, but single-use keys will not. Possible values: 'always', 'never'.
- reusable bool
- Indicates if the key is reusable or single-use. Defaults to
false
. - Sequence[str]
- List of tags to apply to the machines authenticated by the key.
- description String
- A description of the key consisting of alphanumeric characters. Defaults to
""
. - ephemeral Boolean
- Indicates if the key is ephemeral. Defaults to
false
. - expiry Number
- The expiry of the key in seconds. Defaults to
7776000
(90 days). - Boolean
- Determines whether or not the machines authenticated by the key will be authorized for the tailnet by default. Defaults to
false
. - recreate
If StringInvalid - Determines whether the key should be created again if it becomes invalid. By default, reusable keys will be recreated, but single-use keys will not. Possible values: 'always', 'never'.
- reusable Boolean
- Indicates if the key is reusable or single-use. Defaults to
false
. - List<String>
- List of tags to apply to the machines authenticated by the key.
Outputs
All input properties are implicitly available as output properties. Additionally, the TailnetKey resource produces the following output properties:
- Created
At string - The creation timestamp of the key in RFC3339 format
- Expires
At string - The expiry timestamp of the key in RFC3339 format
- Id string
- The provider-assigned unique ID for this managed resource.
- Invalid bool
- Indicates whether the key is invalid (e.g. expired, revoked or has been deleted).
- Key string
- The authentication key
- Created
At string - The creation timestamp of the key in RFC3339 format
- Expires
At string - The expiry timestamp of the key in RFC3339 format
- Id string
- The provider-assigned unique ID for this managed resource.
- Invalid bool
- Indicates whether the key is invalid (e.g. expired, revoked or has been deleted).
- Key string
- The authentication key
- created
At String - The creation timestamp of the key in RFC3339 format
- expires
At String - The expiry timestamp of the key in RFC3339 format
- id String
- The provider-assigned unique ID for this managed resource.
- invalid Boolean
- Indicates whether the key is invalid (e.g. expired, revoked or has been deleted).
- key String
- The authentication key
- created
At string - The creation timestamp of the key in RFC3339 format
- expires
At string - The expiry timestamp of the key in RFC3339 format
- id string
- The provider-assigned unique ID for this managed resource.
- invalid boolean
- Indicates whether the key is invalid (e.g. expired, revoked or has been deleted).
- key string
- The authentication key
- created_
at str - The creation timestamp of the key in RFC3339 format
- expires_
at str - The expiry timestamp of the key in RFC3339 format
- id str
- The provider-assigned unique ID for this managed resource.
- invalid bool
- Indicates whether the key is invalid (e.g. expired, revoked or has been deleted).
- key str
- The authentication key
- created
At String - The creation timestamp of the key in RFC3339 format
- expires
At String - The expiry timestamp of the key in RFC3339 format
- id String
- The provider-assigned unique ID for this managed resource.
- invalid Boolean
- Indicates whether the key is invalid (e.g. expired, revoked or has been deleted).
- key String
- The authentication key
Look up Existing TailnetKey Resource
Get an existing TailnetKey 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?: TailnetKeyState, opts?: CustomResourceOptions): TailnetKey
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
created_at: Optional[str] = None,
description: Optional[str] = None,
ephemeral: Optional[bool] = None,
expires_at: Optional[str] = None,
expiry: Optional[int] = None,
invalid: Optional[bool] = None,
key: Optional[str] = None,
preauthorized: Optional[bool] = None,
recreate_if_invalid: Optional[str] = None,
reusable: Optional[bool] = None,
tags: Optional[Sequence[str]] = None) -> TailnetKey
func GetTailnetKey(ctx *Context, name string, id IDInput, state *TailnetKeyState, opts ...ResourceOption) (*TailnetKey, error)
public static TailnetKey Get(string name, Input<string> id, TailnetKeyState? state, CustomResourceOptions? opts = null)
public static TailnetKey get(String name, Output<String> id, TailnetKeyState 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.
- Created
At string - The creation timestamp of the key in RFC3339 format
- Description string
- A description of the key consisting of alphanumeric characters. Defaults to
""
. - Ephemeral bool
- Indicates if the key is ephemeral. Defaults to
false
. - Expires
At string - The expiry timestamp of the key in RFC3339 format
- Expiry int
- The expiry of the key in seconds. Defaults to
7776000
(90 days). - Invalid bool
- Indicates whether the key is invalid (e.g. expired, revoked or has been deleted).
- Key string
- The authentication key
- bool
- Determines whether or not the machines authenticated by the key will be authorized for the tailnet by default. Defaults to
false
. - Recreate
If stringInvalid - Determines whether the key should be created again if it becomes invalid. By default, reusable keys will be recreated, but single-use keys will not. Possible values: 'always', 'never'.
- Reusable bool
- Indicates if the key is reusable or single-use. Defaults to
false
. - List<string>
- List of tags to apply to the machines authenticated by the key.
- Created
At string - The creation timestamp of the key in RFC3339 format
- Description string
- A description of the key consisting of alphanumeric characters. Defaults to
""
. - Ephemeral bool
- Indicates if the key is ephemeral. Defaults to
false
. - Expires
At string - The expiry timestamp of the key in RFC3339 format
- Expiry int
- The expiry of the key in seconds. Defaults to
7776000
(90 days). - Invalid bool
- Indicates whether the key is invalid (e.g. expired, revoked or has been deleted).
- Key string
- The authentication key
- bool
- Determines whether or not the machines authenticated by the key will be authorized for the tailnet by default. Defaults to
false
. - Recreate
If stringInvalid - Determines whether the key should be created again if it becomes invalid. By default, reusable keys will be recreated, but single-use keys will not. Possible values: 'always', 'never'.
- Reusable bool
- Indicates if the key is reusable or single-use. Defaults to
false
. - []string
- List of tags to apply to the machines authenticated by the key.
- created
At String - The creation timestamp of the key in RFC3339 format
- description String
- A description of the key consisting of alphanumeric characters. Defaults to
""
. - ephemeral Boolean
- Indicates if the key is ephemeral. Defaults to
false
. - expires
At String - The expiry timestamp of the key in RFC3339 format
- expiry Integer
- The expiry of the key in seconds. Defaults to
7776000
(90 days). - invalid Boolean
- Indicates whether the key is invalid (e.g. expired, revoked or has been deleted).
- key String
- The authentication key
- Boolean
- Determines whether or not the machines authenticated by the key will be authorized for the tailnet by default. Defaults to
false
. - recreate
If StringInvalid - Determines whether the key should be created again if it becomes invalid. By default, reusable keys will be recreated, but single-use keys will not. Possible values: 'always', 'never'.
- reusable Boolean
- Indicates if the key is reusable or single-use. Defaults to
false
. - List<String>
- List of tags to apply to the machines authenticated by the key.
- created
At string - The creation timestamp of the key in RFC3339 format
- description string
- A description of the key consisting of alphanumeric characters. Defaults to
""
. - ephemeral boolean
- Indicates if the key is ephemeral. Defaults to
false
. - expires
At string - The expiry timestamp of the key in RFC3339 format
- expiry number
- The expiry of the key in seconds. Defaults to
7776000
(90 days). - invalid boolean
- Indicates whether the key is invalid (e.g. expired, revoked or has been deleted).
- key string
- The authentication key
- boolean
- Determines whether or not the machines authenticated by the key will be authorized for the tailnet by default. Defaults to
false
. - recreate
If stringInvalid - Determines whether the key should be created again if it becomes invalid. By default, reusable keys will be recreated, but single-use keys will not. Possible values: 'always', 'never'.
- reusable boolean
- Indicates if the key is reusable or single-use. Defaults to
false
. - string[]
- List of tags to apply to the machines authenticated by the key.
- created_
at str - The creation timestamp of the key in RFC3339 format
- description str
- A description of the key consisting of alphanumeric characters. Defaults to
""
. - ephemeral bool
- Indicates if the key is ephemeral. Defaults to
false
. - expires_
at str - The expiry timestamp of the key in RFC3339 format
- expiry int
- The expiry of the key in seconds. Defaults to
7776000
(90 days). - invalid bool
- Indicates whether the key is invalid (e.g. expired, revoked or has been deleted).
- key str
- The authentication key
- bool
- Determines whether or not the machines authenticated by the key will be authorized for the tailnet by default. Defaults to
false
. - recreate_
if_ strinvalid - Determines whether the key should be created again if it becomes invalid. By default, reusable keys will be recreated, but single-use keys will not. Possible values: 'always', 'never'.
- reusable bool
- Indicates if the key is reusable or single-use. Defaults to
false
. - Sequence[str]
- List of tags to apply to the machines authenticated by the key.
- created
At String - The creation timestamp of the key in RFC3339 format
- description String
- A description of the key consisting of alphanumeric characters. Defaults to
""
. - ephemeral Boolean
- Indicates if the key is ephemeral. Defaults to
false
. - expires
At String - The expiry timestamp of the key in RFC3339 format
- expiry Number
- The expiry of the key in seconds. Defaults to
7776000
(90 days). - invalid Boolean
- Indicates whether the key is invalid (e.g. expired, revoked or has been deleted).
- key String
- The authentication key
- Boolean
- Determines whether or not the machines authenticated by the key will be authorized for the tailnet by default. Defaults to
false
. - recreate
If StringInvalid - Determines whether the key should be created again if it becomes invalid. By default, reusable keys will be recreated, but single-use keys will not. Possible values: 'always', 'never'.
- reusable Boolean
- Indicates if the key is reusable or single-use. Defaults to
false
. - List<String>
- List of tags to apply to the machines authenticated by the key.
Package Details
- Repository
- tailscale pulumi/pulumi-tailscale
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
tailscale
Terraform Provider.