1. Packages
  2. Unifi
  3. API Docs
  4. DynamicDNS
Unifi v0.1.1 published on Wednesday, Jan 1, 2025 by Pulumiverse

unifi.DynamicDNS

Explore with Pulumi AI

unifi.DynamicDNS manages dynamic DNS settings for different providers.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as unifi from "@pulumiverse/unifi";

const test = new unifi.DynamicDNS("test", {
    service: "dyndns",
    hostName: "my-network.example.com",
    server: "domains.google.com",
    login: dnsLogin,
    password: dnsPassword,
});
Copy
import pulumi
import pulumiverse_unifi as unifi

test = unifi.DynamicDNS("test",
    service="dyndns",
    host_name="my-network.example.com",
    server="domains.google.com",
    login=dns_login,
    password=dns_password)
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := unifi.NewDynamicDNS(ctx, "test", &unifi.DynamicDNSArgs{
			Service:  pulumi.String("dyndns"),
			HostName: pulumi.String("my-network.example.com"),
			Server:   pulumi.String("domains.google.com"),
			Login:    pulumi.Any(dnsLogin),
			Password: pulumi.Any(dnsPassword),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Unifi = Pulumiverse.Unifi;

return await Deployment.RunAsync(() => 
{
    var test = new Unifi.DynamicDNS("test", new()
    {
        Service = "dyndns",
        HostName = "my-network.example.com",
        Server = "domains.google.com",
        Login = dnsLogin,
        Password = dnsPassword,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.unifi.DynamicDNS;
import com.pulumi.unifi.DynamicDNSArgs;
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 test = new DynamicDNS("test", DynamicDNSArgs.builder()
            .service("dyndns")
            .hostName("my-network.example.com")
            .server("domains.google.com")
            .login(dnsLogin)
            .password(dnsPassword)
            .build());

    }
}
Copy
resources:
  test:
    type: unifi:DynamicDNS
    properties:
      service: dyndns
      hostName: my-network.example.com
      server: domains.google.com
      login: ${dnsLogin}
      password: ${dnsPassword}
Copy

Create DynamicDNS Resource

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

Constructor syntax

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

@overload
def DynamicDNS(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               host_name: Optional[str] = None,
               service: Optional[str] = None,
               interface: Optional[str] = None,
               login: Optional[str] = None,
               password: Optional[str] = None,
               server: Optional[str] = None,
               site: Optional[str] = None)
func NewDynamicDNS(ctx *Context, name string, args DynamicDNSArgs, opts ...ResourceOption) (*DynamicDNS, error)
public DynamicDNS(string name, DynamicDNSArgs args, CustomResourceOptions? opts = null)
public DynamicDNS(String name, DynamicDNSArgs args)
public DynamicDNS(String name, DynamicDNSArgs args, CustomResourceOptions options)
type: unifi:DynamicDNS
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. DynamicDNSArgs
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. DynamicDNSArgs
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. DynamicDNSArgs
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. DynamicDNSArgs
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. DynamicDNSArgs
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 dynamicDNSResource = new Unifi.DynamicDNS("dynamicDNSResource", new()
{
    HostName = "string",
    Service = "string",
    Interface = "string",
    Login = "string",
    Password = "string",
    Server = "string",
    Site = "string",
});
Copy
example, err := unifi.NewDynamicDNS(ctx, "dynamicDNSResource", &unifi.DynamicDNSArgs{
	HostName:  pulumi.String("string"),
	Service:   pulumi.String("string"),
	Interface: pulumi.String("string"),
	Login:     pulumi.String("string"),
	Password:  pulumi.String("string"),
	Server:    pulumi.String("string"),
	Site:      pulumi.String("string"),
})
Copy
var dynamicDNSResource = new DynamicDNS("dynamicDNSResource", DynamicDNSArgs.builder()
    .hostName("string")
    .service("string")
    .interface_("string")
    .login("string")
    .password("string")
    .server("string")
    .site("string")
    .build());
Copy
dynamic_dns_resource = unifi.DynamicDNS("dynamicDNSResource",
    host_name="string",
    service="string",
    interface="string",
    login="string",
    password="string",
    server="string",
    site="string")
Copy
const dynamicDNSResource = new unifi.DynamicDNS("dynamicDNSResource", {
    hostName: "string",
    service: "string",
    "interface": "string",
    login: "string",
    password: "string",
    server: "string",
    site: "string",
});
Copy
type: unifi:DynamicDNS
properties:
    hostName: string
    interface: string
    login: string
    password: string
    server: string
    service: string
    site: string
Copy

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

HostName This property is required. string
The host name to update in the dynamic DNS service.
Service
This property is required.
Changes to this property will trigger replacement.
string
The Dynamic DNS service provider, various values are supported (for example dyndns, etc.).
Interface Changes to this property will trigger replacement. string
The interface for the dynamic DNS. Can be wan or wan2. Defaults to wan.
Login string
The server for the dynamic DNS service.
Password string
The server for the dynamic DNS service.
Server string
The server for the dynamic DNS service.
Site Changes to this property will trigger replacement. string
The name of the site to associate the dynamic DNS with.
HostName This property is required. string
The host name to update in the dynamic DNS service.
Service
This property is required.
Changes to this property will trigger replacement.
string
The Dynamic DNS service provider, various values are supported (for example dyndns, etc.).
Interface Changes to this property will trigger replacement. string
The interface for the dynamic DNS. Can be wan or wan2. Defaults to wan.
Login string
The server for the dynamic DNS service.
Password string
The server for the dynamic DNS service.
Server string
The server for the dynamic DNS service.
Site Changes to this property will trigger replacement. string
The name of the site to associate the dynamic DNS with.
hostName This property is required. String
The host name to update in the dynamic DNS service.
service
This property is required.
Changes to this property will trigger replacement.
String
The Dynamic DNS service provider, various values are supported (for example dyndns, etc.).
interface_ Changes to this property will trigger replacement. String
The interface for the dynamic DNS. Can be wan or wan2. Defaults to wan.
login String
The server for the dynamic DNS service.
password String
The server for the dynamic DNS service.
server String
The server for the dynamic DNS service.
site Changes to this property will trigger replacement. String
The name of the site to associate the dynamic DNS with.
hostName This property is required. string
The host name to update in the dynamic DNS service.
service
This property is required.
Changes to this property will trigger replacement.
string
The Dynamic DNS service provider, various values are supported (for example dyndns, etc.).
interface Changes to this property will trigger replacement. string
The interface for the dynamic DNS. Can be wan or wan2. Defaults to wan.
login string
The server for the dynamic DNS service.
password string
The server for the dynamic DNS service.
server string
The server for the dynamic DNS service.
site Changes to this property will trigger replacement. string
The name of the site to associate the dynamic DNS with.
host_name This property is required. str
The host name to update in the dynamic DNS service.
service
This property is required.
Changes to this property will trigger replacement.
str
The Dynamic DNS service provider, various values are supported (for example dyndns, etc.).
interface Changes to this property will trigger replacement. str
The interface for the dynamic DNS. Can be wan or wan2. Defaults to wan.
login str
The server for the dynamic DNS service.
password str
The server for the dynamic DNS service.
server str
The server for the dynamic DNS service.
site Changes to this property will trigger replacement. str
The name of the site to associate the dynamic DNS with.
hostName This property is required. String
The host name to update in the dynamic DNS service.
service
This property is required.
Changes to this property will trigger replacement.
String
The Dynamic DNS service provider, various values are supported (for example dyndns, etc.).
interface Changes to this property will trigger replacement. String
The interface for the dynamic DNS. Can be wan or wan2. Defaults to wan.
login String
The server for the dynamic DNS service.
password String
The server for the dynamic DNS service.
server String
The server for the dynamic DNS service.
site Changes to this property will trigger replacement. String
The name of the site to associate the dynamic DNS with.

Outputs

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

Get an existing DynamicDNS 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?: DynamicDNSState, opts?: CustomResourceOptions): DynamicDNS
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        host_name: Optional[str] = None,
        interface: Optional[str] = None,
        login: Optional[str] = None,
        password: Optional[str] = None,
        server: Optional[str] = None,
        service: Optional[str] = None,
        site: Optional[str] = None) -> DynamicDNS
func GetDynamicDNS(ctx *Context, name string, id IDInput, state *DynamicDNSState, opts ...ResourceOption) (*DynamicDNS, error)
public static DynamicDNS Get(string name, Input<string> id, DynamicDNSState? state, CustomResourceOptions? opts = null)
public static DynamicDNS get(String name, Output<String> id, DynamicDNSState state, CustomResourceOptions options)
resources:  _:    type: unifi:DynamicDNS    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:
HostName string
The host name to update in the dynamic DNS service.
Interface Changes to this property will trigger replacement. string
The interface for the dynamic DNS. Can be wan or wan2. Defaults to wan.
Login string
The server for the dynamic DNS service.
Password string
The server for the dynamic DNS service.
Server string
The server for the dynamic DNS service.
Service Changes to this property will trigger replacement. string
The Dynamic DNS service provider, various values are supported (for example dyndns, etc.).
Site Changes to this property will trigger replacement. string
The name of the site to associate the dynamic DNS with.
HostName string
The host name to update in the dynamic DNS service.
Interface Changes to this property will trigger replacement. string
The interface for the dynamic DNS. Can be wan or wan2. Defaults to wan.
Login string
The server for the dynamic DNS service.
Password string
The server for the dynamic DNS service.
Server string
The server for the dynamic DNS service.
Service Changes to this property will trigger replacement. string
The Dynamic DNS service provider, various values are supported (for example dyndns, etc.).
Site Changes to this property will trigger replacement. string
The name of the site to associate the dynamic DNS with.
hostName String
The host name to update in the dynamic DNS service.
interface_ Changes to this property will trigger replacement. String
The interface for the dynamic DNS. Can be wan or wan2. Defaults to wan.
login String
The server for the dynamic DNS service.
password String
The server for the dynamic DNS service.
server String
The server for the dynamic DNS service.
service Changes to this property will trigger replacement. String
The Dynamic DNS service provider, various values are supported (for example dyndns, etc.).
site Changes to this property will trigger replacement. String
The name of the site to associate the dynamic DNS with.
hostName string
The host name to update in the dynamic DNS service.
interface Changes to this property will trigger replacement. string
The interface for the dynamic DNS. Can be wan or wan2. Defaults to wan.
login string
The server for the dynamic DNS service.
password string
The server for the dynamic DNS service.
server string
The server for the dynamic DNS service.
service Changes to this property will trigger replacement. string
The Dynamic DNS service provider, various values are supported (for example dyndns, etc.).
site Changes to this property will trigger replacement. string
The name of the site to associate the dynamic DNS with.
host_name str
The host name to update in the dynamic DNS service.
interface Changes to this property will trigger replacement. str
The interface for the dynamic DNS. Can be wan or wan2. Defaults to wan.
login str
The server for the dynamic DNS service.
password str
The server for the dynamic DNS service.
server str
The server for the dynamic DNS service.
service Changes to this property will trigger replacement. str
The Dynamic DNS service provider, various values are supported (for example dyndns, etc.).
site Changes to this property will trigger replacement. str
The name of the site to associate the dynamic DNS with.
hostName String
The host name to update in the dynamic DNS service.
interface Changes to this property will trigger replacement. String
The interface for the dynamic DNS. Can be wan or wan2. Defaults to wan.
login String
The server for the dynamic DNS service.
password String
The server for the dynamic DNS service.
server String
The server for the dynamic DNS service.
service Changes to this property will trigger replacement. String
The Dynamic DNS service provider, various values are supported (for example dyndns, etc.).
site Changes to this property will trigger replacement. String
The name of the site to associate the dynamic DNS with.

Package Details

Repository
unifi pulumiverse/pulumi-unifi
License
Apache-2.0
Notes
This Pulumi package is based on the unifi Terraform Provider.