1. Packages
  2. F5bigip Provider
  3. API Docs
  4. sys
  5. Dns
f5 BIG-IP v3.17.7 published on Wednesday, Dec 4, 2024 by Pulumi

f5bigip.sys.Dns

Explore with Pulumi AI

f5bigip logo
f5 BIG-IP v3.17.7 published on Wednesday, Dec 4, 2024 by Pulumi

    f5bigip.sys.Dns Configures DNS Name server on F5 BIG-IP

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as f5bigip from "@pulumi/f5bigip";
    
    const dns1 = new f5bigip.sys.Dns("dns1", {
        description: "/Common/DNS1",
        nameServers: ["1.1.1.1"],
        searches: ["f5.com"],
    });
    
    import pulumi
    import pulumi_f5bigip as f5bigip
    
    dns1 = f5bigip.sys.Dns("dns1",
        description="/Common/DNS1",
        name_servers=["1.1.1.1"],
        searches=["f5.com"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-f5bigip/sdk/v3/go/f5bigip/sys"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := sys.NewDns(ctx, "dns1", &sys.DnsArgs{
    			Description: pulumi.String("/Common/DNS1"),
    			NameServers: pulumi.StringArray{
    				pulumi.String("1.1.1.1"),
    			},
    			Searches: pulumi.StringArray{
    				pulumi.String("f5.com"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using F5BigIP = Pulumi.F5BigIP;
    
    return await Deployment.RunAsync(() => 
    {
        var dns1 = new F5BigIP.Sys.Dns("dns1", new()
        {
            Description = "/Common/DNS1",
            NameServers = new[]
            {
                "1.1.1.1",
            },
            Searches = new[]
            {
                "f5.com",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.f5bigip.sys.Dns;
    import com.pulumi.f5bigip.sys.DnsArgs;
    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 dns1 = new Dns("dns1", DnsArgs.builder()
                .description("/Common/DNS1")
                .nameServers("1.1.1.1")
                .searches("f5.com")
                .build());
    
        }
    }
    
    resources:
      dns1:
        type: f5bigip:sys:Dns
        properties:
          description: /Common/DNS1
          nameServers:
            - 1.1.1.1
          searches:
            - f5.com
    

    Create Dns Resource

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

    Constructor syntax

    new Dns(name: string, args: DnsArgs, opts?: CustomResourceOptions);
    @overload
    def Dns(resource_name: str,
            args: DnsArgs,
            opts: Optional[ResourceOptions] = None)
    
    @overload
    def Dns(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            name_servers: Optional[Sequence[str]] = None,
            number_of_dots: Optional[int] = None,
            searches: Optional[Sequence[str]] = None)
    func NewDns(ctx *Context, name string, args DnsArgs, opts ...ResourceOption) (*Dns, error)
    public Dns(string name, DnsArgs args, CustomResourceOptions? opts = null)
    public Dns(String name, DnsArgs args)
    public Dns(String name, DnsArgs args, CustomResourceOptions options)
    
    type: f5bigip:sys:Dns
    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 DnsArgs
    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 DnsArgs
    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 DnsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DnsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DnsArgs
    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 dnsResource = new F5BigIP.Sys.Dns("dnsResource", new()
    {
        Description = "string",
        NameServers = new[]
        {
            "string",
        },
        NumberOfDots = 0,
        Searches = new[]
        {
            "string",
        },
    });
    
    example, err := sys.NewDns(ctx, "dnsResource", &sys.DnsArgs{
    	Description: pulumi.String("string"),
    	NameServers: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	NumberOfDots: pulumi.Int(0),
    	Searches: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    var dnsResource = new Dns("dnsResource", DnsArgs.builder()
        .description("string")
        .nameServers("string")
        .numberOfDots(0)
        .searches("string")
        .build());
    
    dns_resource = f5bigip.sys.Dns("dnsResource",
        description="string",
        name_servers=["string"],
        number_of_dots=0,
        searches=["string"])
    
    const dnsResource = new f5bigip.sys.Dns("dnsResource", {
        description: "string",
        nameServers: ["string"],
        numberOfDots: 0,
        searches: ["string"],
    });
    
    type: f5bigip:sys:Dns
    properties:
        description: string
        nameServers:
            - string
        numberOfDots: 0
        searches:
            - string
    

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

    Description string
    Provide description for your DNS server
    NameServers List<string>
    Specifies the name servers that the system uses to validate DNS lookups, and resolve host names.
    NumberOfDots int
    Configures the number of dots needed in a name before an initial absolute query will be made.
    Searches List<string>
    Specifies the domains that the system searches for local domain lookups, to resolve local host names.
    Description string
    Provide description for your DNS server
    NameServers []string
    Specifies the name servers that the system uses to validate DNS lookups, and resolve host names.
    NumberOfDots int
    Configures the number of dots needed in a name before an initial absolute query will be made.
    Searches []string
    Specifies the domains that the system searches for local domain lookups, to resolve local host names.
    description String
    Provide description for your DNS server
    nameServers List<String>
    Specifies the name servers that the system uses to validate DNS lookups, and resolve host names.
    numberOfDots Integer
    Configures the number of dots needed in a name before an initial absolute query will be made.
    searches List<String>
    Specifies the domains that the system searches for local domain lookups, to resolve local host names.
    description string
    Provide description for your DNS server
    nameServers string[]
    Specifies the name servers that the system uses to validate DNS lookups, and resolve host names.
    numberOfDots number
    Configures the number of dots needed in a name before an initial absolute query will be made.
    searches string[]
    Specifies the domains that the system searches for local domain lookups, to resolve local host names.
    description str
    Provide description for your DNS server
    name_servers Sequence[str]
    Specifies the name servers that the system uses to validate DNS lookups, and resolve host names.
    number_of_dots int
    Configures the number of dots needed in a name before an initial absolute query will be made.
    searches Sequence[str]
    Specifies the domains that the system searches for local domain lookups, to resolve local host names.
    description String
    Provide description for your DNS server
    nameServers List<String>
    Specifies the name servers that the system uses to validate DNS lookups, and resolve host names.
    numberOfDots Number
    Configures the number of dots needed in a name before an initial absolute query will be made.
    searches List<String>
    Specifies the domains that the system searches for local domain lookups, to resolve local host names.

    Outputs

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

    Get an existing Dns 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?: DnsState, opts?: CustomResourceOptions): Dns
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            name_servers: Optional[Sequence[str]] = None,
            number_of_dots: Optional[int] = None,
            searches: Optional[Sequence[str]] = None) -> Dns
    func GetDns(ctx *Context, name string, id IDInput, state *DnsState, opts ...ResourceOption) (*Dns, error)
    public static Dns Get(string name, Input<string> id, DnsState? state, CustomResourceOptions? opts = null)
    public static Dns get(String name, Output<String> id, DnsState 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:
    Description string
    Provide description for your DNS server
    NameServers List<string>
    Specifies the name servers that the system uses to validate DNS lookups, and resolve host names.
    NumberOfDots int
    Configures the number of dots needed in a name before an initial absolute query will be made.
    Searches List<string>
    Specifies the domains that the system searches for local domain lookups, to resolve local host names.
    Description string
    Provide description for your DNS server
    NameServers []string
    Specifies the name servers that the system uses to validate DNS lookups, and resolve host names.
    NumberOfDots int
    Configures the number of dots needed in a name before an initial absolute query will be made.
    Searches []string
    Specifies the domains that the system searches for local domain lookups, to resolve local host names.
    description String
    Provide description for your DNS server
    nameServers List<String>
    Specifies the name servers that the system uses to validate DNS lookups, and resolve host names.
    numberOfDots Integer
    Configures the number of dots needed in a name before an initial absolute query will be made.
    searches List<String>
    Specifies the domains that the system searches for local domain lookups, to resolve local host names.
    description string
    Provide description for your DNS server
    nameServers string[]
    Specifies the name servers that the system uses to validate DNS lookups, and resolve host names.
    numberOfDots number
    Configures the number of dots needed in a name before an initial absolute query will be made.
    searches string[]
    Specifies the domains that the system searches for local domain lookups, to resolve local host names.
    description str
    Provide description for your DNS server
    name_servers Sequence[str]
    Specifies the name servers that the system uses to validate DNS lookups, and resolve host names.
    number_of_dots int
    Configures the number of dots needed in a name before an initial absolute query will be made.
    searches Sequence[str]
    Specifies the domains that the system searches for local domain lookups, to resolve local host names.
    description String
    Provide description for your DNS server
    nameServers List<String>
    Specifies the name servers that the system uses to validate DNS lookups, and resolve host names.
    numberOfDots Number
    Configures the number of dots needed in a name before an initial absolute query will be made.
    searches List<String>
    Specifies the domains that the system searches for local domain lookups, to resolve local host names.

    Package Details

    Repository
    f5 BIG-IP pulumi/pulumi-f5bigip
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the bigip Terraform Provider.
    f5bigip logo
    f5 BIG-IP v3.17.7 published on Wednesday, Dec 4, 2024 by Pulumi