Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Tailscale Provider
  3. API Docs
  4. DnsSearchPaths
Tailscale v0.19.0 published on Thursday, Apr 10, 2025 by Pulumi
pulumi/pulumi-tailscale

tailscale.DnsSearchPaths

Explore with Pulumi AI

Tailscale v0.19.0 published on Thursday, Apr 10, 2025 by Pulumi
pulumi/pulumi-tailscale

The dns_nameservers resource allows you to configure DNS nameservers for your Tailscale network. See https://tailscale.com/kb/1054/dns for more information.

Example Usage

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

const sampleSearchPaths = new tailscale.DnsSearchPaths("sample_search_paths", {searchPaths: ["example.com"]});
Copy
import pulumi
import pulumi_tailscale as tailscale

sample_search_paths = tailscale.DnsSearchPaths("sample_search_paths", search_paths=["example.com"])
Copy
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.NewDnsSearchPaths(ctx, "sample_search_paths", &tailscale.DnsSearchPathsArgs{
			SearchPaths: pulumi.StringArray{
				pulumi.String("example.com"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Tailscale = Pulumi.Tailscale;

return await Deployment.RunAsync(() => 
{
    var sampleSearchPaths = new Tailscale.DnsSearchPaths("sample_search_paths", new()
    {
        SearchPaths = new[]
        {
            "example.com",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tailscale.DnsSearchPaths;
import com.pulumi.tailscale.DnsSearchPathsArgs;
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 sampleSearchPaths = new DnsSearchPaths("sampleSearchPaths", DnsSearchPathsArgs.builder()
            .searchPaths("example.com")
            .build());

    }
}
Copy
resources:
  sampleSearchPaths:
    type: tailscale:DnsSearchPaths
    name: sample_search_paths
    properties:
      searchPaths:
        - example.com
Copy

Create DnsSearchPaths Resource

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

Constructor syntax

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

@overload
def DnsSearchPaths(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   search_paths: Optional[Sequence[str]] = None)
func NewDnsSearchPaths(ctx *Context, name string, args DnsSearchPathsArgs, opts ...ResourceOption) (*DnsSearchPaths, error)
public DnsSearchPaths(string name, DnsSearchPathsArgs args, CustomResourceOptions? opts = null)
public DnsSearchPaths(String name, DnsSearchPathsArgs args)
public DnsSearchPaths(String name, DnsSearchPathsArgs args, CustomResourceOptions options)

type: tailscale:DnsSearchPaths
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. DnsSearchPathsArgs
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. DnsSearchPathsArgs
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. DnsSearchPathsArgs
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. DnsSearchPathsArgs
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. DnsSearchPathsArgs
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 dnsSearchPathsResource = new Tailscale.DnsSearchPaths("dnsSearchPathsResource", new()
{
    SearchPaths = new[]
    {
        "string",
    },
});
Copy
example, err := tailscale.NewDnsSearchPaths(ctx, "dnsSearchPathsResource", &tailscale.DnsSearchPathsArgs{
	SearchPaths: pulumi.StringArray{
		pulumi.String("string"),
	},
})
Copy
var dnsSearchPathsResource = new DnsSearchPaths("dnsSearchPathsResource", DnsSearchPathsArgs.builder()
    .searchPaths("string")
    .build());
Copy
dns_search_paths_resource = tailscale.DnsSearchPaths("dnsSearchPathsResource", search_paths=["string"])
Copy
const dnsSearchPathsResource = new tailscale.DnsSearchPaths("dnsSearchPathsResource", {searchPaths: ["string"]});
Copy
type: tailscale:DnsSearchPaths
properties:
    searchPaths:
        - string
Copy

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

SearchPaths This property is required. List<string>
Devices on your network will use these domain suffixes to resolve DNS names.
SearchPaths This property is required. []string
Devices on your network will use these domain suffixes to resolve DNS names.
searchPaths This property is required. List<String>
Devices on your network will use these domain suffixes to resolve DNS names.
searchPaths This property is required. string[]
Devices on your network will use these domain suffixes to resolve DNS names.
search_paths This property is required. Sequence[str]
Devices on your network will use these domain suffixes to resolve DNS names.
searchPaths This property is required. List<String>
Devices on your network will use these domain suffixes to resolve DNS names.

Outputs

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

Get an existing DnsSearchPaths 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?: DnsSearchPathsState, opts?: CustomResourceOptions): DnsSearchPaths
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        search_paths: Optional[Sequence[str]] = None) -> DnsSearchPaths
func GetDnsSearchPaths(ctx *Context, name string, id IDInput, state *DnsSearchPathsState, opts ...ResourceOption) (*DnsSearchPaths, error)
public static DnsSearchPaths Get(string name, Input<string> id, DnsSearchPathsState? state, CustomResourceOptions? opts = null)
public static DnsSearchPaths get(String name, Output<String> id, DnsSearchPathsState state, CustomResourceOptions options)
resources:  _:    type: tailscale:DnsSearchPaths    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:
SearchPaths List<string>
Devices on your network will use these domain suffixes to resolve DNS names.
SearchPaths []string
Devices on your network will use these domain suffixes to resolve DNS names.
searchPaths List<String>
Devices on your network will use these domain suffixes to resolve DNS names.
searchPaths string[]
Devices on your network will use these domain suffixes to resolve DNS names.
search_paths Sequence[str]
Devices on your network will use these domain suffixes to resolve DNS names.
searchPaths List<String>
Devices on your network will use these domain suffixes to resolve DNS names.

Import

ID doesn’t matter.

$ pulumi import tailscale:index/dnsSearchPaths:DnsSearchPaths sample dns_search_paths
Copy

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

Package Details

Repository
tailscale pulumi/pulumi-tailscale
License
Apache-2.0
Notes
This Pulumi package is based on the tailscale Terraform Provider.
Tailscale v0.19.0 published on Thursday, Apr 10, 2025 by Pulumi
pulumi/pulumi-tailscale