1. Packages
  2. Tailscale Provider
  3. API Docs
  4. DnsPreferences
Tailscale v0.17.4 published on Thursday, Oct 24, 2024 by Pulumi

tailscale.DnsPreferences

Explore with Pulumi AI

tailscale logo
Tailscale v0.17.4 published on Thursday, Oct 24, 2024 by Pulumi

    The dns_preferences resource allows you to configure DNS preferences 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 samplePreferences = new tailscale.DnsPreferences("sample_preferences", {magicDns: true});
    
    import pulumi
    import pulumi_tailscale as tailscale
    
    sample_preferences = tailscale.DnsPreferences("sample_preferences", magic_dns=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.NewDnsPreferences(ctx, "sample_preferences", &tailscale.DnsPreferencesArgs{
    			MagicDns: pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Tailscale = Pulumi.Tailscale;
    
    return await Deployment.RunAsync(() => 
    {
        var samplePreferences = new Tailscale.DnsPreferences("sample_preferences", new()
        {
            MagicDns = true,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.tailscale.DnsPreferences;
    import com.pulumi.tailscale.DnsPreferencesArgs;
    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 samplePreferences = new DnsPreferences("samplePreferences", DnsPreferencesArgs.builder()
                .magicDns(true)
                .build());
    
        }
    }
    
    resources:
      samplePreferences:
        type: tailscale:DnsPreferences
        name: sample_preferences
        properties:
          magicDns: true
    

    Create DnsPreferences Resource

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

    Constructor syntax

    new DnsPreferences(name: string, args: DnsPreferencesArgs, opts?: CustomResourceOptions);
    @overload
    def DnsPreferences(resource_name: str,
                       args: DnsPreferencesArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def DnsPreferences(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       magic_dns: Optional[bool] = None)
    func NewDnsPreferences(ctx *Context, name string, args DnsPreferencesArgs, opts ...ResourceOption) (*DnsPreferences, error)
    public DnsPreferences(string name, DnsPreferencesArgs args, CustomResourceOptions? opts = null)
    public DnsPreferences(String name, DnsPreferencesArgs args)
    public DnsPreferences(String name, DnsPreferencesArgs args, CustomResourceOptions options)
    
    type: tailscale:DnsPreferences
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args DnsPreferencesArgs
    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 DnsPreferencesArgs
    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 DnsPreferencesArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DnsPreferencesArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DnsPreferencesArgs
    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 dnsPreferencesResource = new Tailscale.DnsPreferences("dnsPreferencesResource", new()
    {
        MagicDns = false,
    });
    
    example, err := tailscale.NewDnsPreferences(ctx, "dnsPreferencesResource", &tailscale.DnsPreferencesArgs{
    	MagicDns: pulumi.Bool(false),
    })
    
    var dnsPreferencesResource = new DnsPreferences("dnsPreferencesResource", DnsPreferencesArgs.builder()
        .magicDns(false)
        .build());
    
    dns_preferences_resource = tailscale.DnsPreferences("dnsPreferencesResource", magic_dns=False)
    
    const dnsPreferencesResource = new tailscale.DnsPreferences("dnsPreferencesResource", {magicDns: false});
    
    type: tailscale:DnsPreferences
    properties:
        magicDns: false
    

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

    MagicDns bool
    Whether or not to enable magic DNS
    MagicDns bool
    Whether or not to enable magic DNS
    magicDns Boolean
    Whether or not to enable magic DNS
    magicDns boolean
    Whether or not to enable magic DNS
    magic_dns bool
    Whether or not to enable magic DNS
    magicDns Boolean
    Whether or not to enable magic DNS

    Outputs

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

    Get an existing DnsPreferences 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?: DnsPreferencesState, opts?: CustomResourceOptions): DnsPreferences
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            magic_dns: Optional[bool] = None) -> DnsPreferences
    func GetDnsPreferences(ctx *Context, name string, id IDInput, state *DnsPreferencesState, opts ...ResourceOption) (*DnsPreferences, error)
    public static DnsPreferences Get(string name, Input<string> id, DnsPreferencesState? state, CustomResourceOptions? opts = null)
    public static DnsPreferences get(String name, Output<String> id, DnsPreferencesState 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:
    MagicDns bool
    Whether or not to enable magic DNS
    MagicDns bool
    Whether or not to enable magic DNS
    magicDns Boolean
    Whether or not to enable magic DNS
    magicDns boolean
    Whether or not to enable magic DNS
    magic_dns bool
    Whether or not to enable magic DNS
    magicDns Boolean
    Whether or not to enable magic DNS

    Import

    ID doesn’t matter.

    $ pulumi import tailscale:index/dnsPreferences:DnsPreferences sample_preferences dns_preferences
    

    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 logo
    Tailscale v0.17.4 published on Thursday, Oct 24, 2024 by Pulumi