Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Infoblox Provider
  3. API Docs
  4. AliasRecord
infoblox 2.10.0 published on Friday, Apr 25, 2025 by infobloxopen
infobloxopen/terraform-provider-infoblox

infoblox.AliasRecord

Explore with Pulumi AI

infoblox 2.10.0 published on Friday, Apr 25, 2025 by infobloxopen
infobloxopen/terraform-provider-infoblox

# Alias-record Resource

The infoblox.AliasRecord resource enables you to perform create, update and delete operations on Alias Record in a NIOS appliance. The resource represents the ‘record:alias’ WAPI object in NIOS.

The following list describes the parameters you can define in the infoblox.AliasRecord resource block:

  • name: required, specifies the alias name in the FQDN format. Example: alias1.example.com.
  • target_name: required, specifies the target name in the FQDN format. Example: main.example.com.
  • target_type: required, specifies the type of the target object. Valid values are: A, AAAA, MX, NAPTR, PTR, SPF, SRV and TXT.
  • ttl: optional, specifies the “time to live” value for the alias-record. There is no default value for this parameter. If a value is not specified, then in NIOS, the value is inherited from the parent zone of the DNS record for this resource. A TTL value of 0 (zero) means caching should be disabled for this record. Example: 3600.
  • disable: optional, specifies whether the alias record is disabled or not. Default value is false.
  • dns_view: optional, specifies the DNS view in which the zone exists. If a value is not specified, the name default is set as the DNS view. Example: dns_view_1.
  • comment: optional, describes the alias-record. Example: an example alias-record.
  • ext_attrs: optional, specifies the set of NIOS extensible attributes that are attached to the alias-record. Example: jsonencode({"Site":"Singapore"}).

Example of an Alias-record Resource

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

// Alias-record, minimal set of parameters
const aliasRecordMinimumParams = new infoblox.AliasRecord("aliasRecordMinimumParams", {
    targetName: "aa.bb.com",
    targetType: "PTR",
});
// Alias-record, full set of parameters
const aliasRecordFullParams = new infoblox.AliasRecord("aliasRecordFullParams", {
    targetName: "kk.ll.com",
    targetType: "AAAA",
    comment: "example alias record",
    dnsView: "view2",
    disable: false,
    ttl: 120,
    extAttrs: JSON.stringify({
        Site: "MOROCCO",
    }),
});
Copy
import pulumi
import json
import pulumi_infoblox as infoblox

# Alias-record, minimal set of parameters
alias_record_minimum_params = infoblox.AliasRecord("aliasRecordMinimumParams",
    target_name="aa.bb.com",
    target_type="PTR")
# Alias-record, full set of parameters
alias_record_full_params = infoblox.AliasRecord("aliasRecordFullParams",
    target_name="kk.ll.com",
    target_type="AAAA",
    comment="example alias record",
    dns_view="view2",
    disable=False,
    ttl=120,
    ext_attrs=json.dumps({
        "Site": "MOROCCO",
    }))
Copy
package main

import (
	"encoding/json"

	"github.com/pulumi/pulumi-terraform-provider/sdks/go/infoblox/v2/infoblox"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Alias-record, minimal set of parameters
		_, err := infoblox.NewAliasRecord(ctx, "aliasRecordMinimumParams", &infoblox.AliasRecordArgs{
			TargetName: pulumi.String("aa.bb.com"),
			TargetType: pulumi.String("PTR"),
		})
		if err != nil {
			return err
		}
		tmpJSON0, err := json.Marshal(map[string]interface{}{
			"Site": "MOROCCO",
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		// Alias-record, full set of parameters
		_, err = infoblox.NewAliasRecord(ctx, "aliasRecordFullParams", &infoblox.AliasRecordArgs{
			TargetName: pulumi.String("kk.ll.com"),
			TargetType: pulumi.String("AAAA"),
			Comment:    pulumi.String("example alias record"),
			DnsView:    pulumi.String("view2"),
			Disable:    pulumi.Bool(false),
			Ttl:        pulumi.Float64(120),
			ExtAttrs:   pulumi.String(json0),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Infoblox = Pulumi.Infoblox;

return await Deployment.RunAsync(() => 
{
    // Alias-record, minimal set of parameters
    var aliasRecordMinimumParams = new Infoblox.AliasRecord("aliasRecordMinimumParams", new()
    {
        TargetName = "aa.bb.com",
        TargetType = "PTR",
    });

    // Alias-record, full set of parameters
    var aliasRecordFullParams = new Infoblox.AliasRecord("aliasRecordFullParams", new()
    {
        TargetName = "kk.ll.com",
        TargetType = "AAAA",
        Comment = "example alias record",
        DnsView = "view2",
        Disable = false,
        Ttl = 120,
        ExtAttrs = JsonSerializer.Serialize(new Dictionary<string, object?>
        {
            ["Site"] = "MOROCCO",
        }),
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.infoblox.AliasRecord;
import com.pulumi.infoblox.AliasRecordArgs;
import static com.pulumi.codegen.internal.Serialization.*;
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) {
        // Alias-record, minimal set of parameters
        var aliasRecordMinimumParams = new AliasRecord("aliasRecordMinimumParams", AliasRecordArgs.builder()
            .targetName("aa.bb.com")
            .targetType("PTR")
            .build());

        // Alias-record, full set of parameters
        var aliasRecordFullParams = new AliasRecord("aliasRecordFullParams", AliasRecordArgs.builder()
            .targetName("kk.ll.com")
            .targetType("AAAA")
            .comment("example alias record")
            .dnsView("view2")
            .disable(false)
            .ttl(120)
            .extAttrs(serializeJson(
                jsonObject(
                    jsonProperty("Site", "MOROCCO")
                )))
            .build());

    }
}
Copy
resources:
  # Alias-record, minimal set of parameters
  aliasRecordMinimumParams:
    type: infoblox:AliasRecord
    properties:
      targetName: aa.bb.com
      targetType: PTR
  # Alias-record, full set of parameters
  aliasRecordFullParams:
    type: infoblox:AliasRecord
    properties:
      targetName: kk.ll.com
      targetType: AAAA
      comment: example alias record
      dnsView: view2
      disable: false
      ttl: 120
      extAttrs:
        fn::toJSON:
          Site: MOROCCO
Copy

Create AliasRecord Resource

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

Constructor syntax

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

@overload
def AliasRecord(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                target_name: Optional[str] = None,
                target_type: Optional[str] = None,
                alias_record_id: Optional[str] = None,
                comment: Optional[str] = None,
                disable: Optional[bool] = None,
                dns_view: Optional[str] = None,
                ext_attrs: Optional[str] = None,
                name: Optional[str] = None,
                ttl: Optional[float] = None)
func NewAliasRecord(ctx *Context, name string, args AliasRecordArgs, opts ...ResourceOption) (*AliasRecord, error)
public AliasRecord(string name, AliasRecordArgs args, CustomResourceOptions? opts = null)
public AliasRecord(String name, AliasRecordArgs args)
public AliasRecord(String name, AliasRecordArgs args, CustomResourceOptions options)

type: infoblox:AliasRecord
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. AliasRecordArgs
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. AliasRecordArgs
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. AliasRecordArgs
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. AliasRecordArgs
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. AliasRecordArgs
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 aliasRecordResource = new Infoblox.AliasRecord("aliasRecordResource", new()
{
    TargetName = "string",
    TargetType = "string",
    AliasRecordId = "string",
    Comment = "string",
    Disable = false,
    DnsView = "string",
    ExtAttrs = "string",
    Name = "string",
    Ttl = 0,
});
Copy
example, err := infoblox.NewAliasRecord(ctx, "aliasRecordResource", &infoblox.AliasRecordArgs{
	TargetName:    pulumi.String("string"),
	TargetType:    pulumi.String("string"),
	AliasRecordId: pulumi.String("string"),
	Comment:       pulumi.String("string"),
	Disable:       pulumi.Bool(false),
	DnsView:       pulumi.String("string"),
	ExtAttrs:      pulumi.String("string"),
	Name:          pulumi.String("string"),
	Ttl:           pulumi.Float64(0),
})
Copy
var aliasRecordResource = new AliasRecord("aliasRecordResource", AliasRecordArgs.builder()
    .targetName("string")
    .targetType("string")
    .aliasRecordId("string")
    .comment("string")
    .disable(false)
    .dnsView("string")
    .extAttrs("string")
    .name("string")
    .ttl(0)
    .build());
Copy
alias_record_resource = infoblox.AliasRecord("aliasRecordResource",
    target_name="string",
    target_type="string",
    alias_record_id="string",
    comment="string",
    disable=False,
    dns_view="string",
    ext_attrs="string",
    name="string",
    ttl=0)
Copy
const aliasRecordResource = new infoblox.AliasRecord("aliasRecordResource", {
    targetName: "string",
    targetType: "string",
    aliasRecordId: "string",
    comment: "string",
    disable: false,
    dnsView: "string",
    extAttrs: "string",
    name: "string",
    ttl: 0,
});
Copy
type: infoblox:AliasRecord
properties:
    aliasRecordId: string
    comment: string
    disable: false
    dnsView: string
    extAttrs: string
    name: string
    targetName: string
    targetType: string
    ttl: 0
Copy

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

TargetName This property is required. string
Target name in FQDN format.
TargetType This property is required. string
Type of the target object.
AliasRecordId string
Comment string
Comment for the alias record.
Disable bool
A boolean flag which indicates if the alias record is disabled.
DnsView string
Name of the DNS view in which the alias record is created.
ExtAttrs string
Extensible attributes of the Alias Record to be added/updated, as a map in JSON format
Name string
Name of the alias record.
Ttl double
The Time To Live (TTL) value for record. A 32-bit unsigned integer that represents the duration, in seconds, for which the record is valid (cached). Zero indicates that the record should not be cached.
TargetName This property is required. string
Target name in FQDN format.
TargetType This property is required. string
Type of the target object.
AliasRecordId string
Comment string
Comment for the alias record.
Disable bool
A boolean flag which indicates if the alias record is disabled.
DnsView string
Name of the DNS view in which the alias record is created.
ExtAttrs string
Extensible attributes of the Alias Record to be added/updated, as a map in JSON format
Name string
Name of the alias record.
Ttl float64
The Time To Live (TTL) value for record. A 32-bit unsigned integer that represents the duration, in seconds, for which the record is valid (cached). Zero indicates that the record should not be cached.
targetName This property is required. String
Target name in FQDN format.
targetType This property is required. String
Type of the target object.
aliasRecordId String
comment String
Comment for the alias record.
disable Boolean
A boolean flag which indicates if the alias record is disabled.
dnsView String
Name of the DNS view in which the alias record is created.
extAttrs String
Extensible attributes of the Alias Record to be added/updated, as a map in JSON format
name String
Name of the alias record.
ttl Double
The Time To Live (TTL) value for record. A 32-bit unsigned integer that represents the duration, in seconds, for which the record is valid (cached). Zero indicates that the record should not be cached.
targetName This property is required. string
Target name in FQDN format.
targetType This property is required. string
Type of the target object.
aliasRecordId string
comment string
Comment for the alias record.
disable boolean
A boolean flag which indicates if the alias record is disabled.
dnsView string
Name of the DNS view in which the alias record is created.
extAttrs string
Extensible attributes of the Alias Record to be added/updated, as a map in JSON format
name string
Name of the alias record.
ttl number
The Time To Live (TTL) value for record. A 32-bit unsigned integer that represents the duration, in seconds, for which the record is valid (cached). Zero indicates that the record should not be cached.
target_name This property is required. str
Target name in FQDN format.
target_type This property is required. str
Type of the target object.
alias_record_id str
comment str
Comment for the alias record.
disable bool
A boolean flag which indicates if the alias record is disabled.
dns_view str
Name of the DNS view in which the alias record is created.
ext_attrs str
Extensible attributes of the Alias Record to be added/updated, as a map in JSON format
name str
Name of the alias record.
ttl float
The Time To Live (TTL) value for record. A 32-bit unsigned integer that represents the duration, in seconds, for which the record is valid (cached). Zero indicates that the record should not be cached.
targetName This property is required. String
Target name in FQDN format.
targetType This property is required. String
Type of the target object.
aliasRecordId String
comment String
Comment for the alias record.
disable Boolean
A boolean flag which indicates if the alias record is disabled.
dnsView String
Name of the DNS view in which the alias record is created.
extAttrs String
Extensible attributes of the Alias Record to be added/updated, as a map in JSON format
name String
Name of the alias record.
ttl Number
The Time To Live (TTL) value for record. A 32-bit unsigned integer that represents the duration, in seconds, for which the record is valid (cached). Zero indicates that the record should not be cached.

Outputs

All input properties are implicitly available as output properties. Additionally, the AliasRecord resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
InternalId string
Ref string
NIOS object's reference, not to be set by a user.
Id string
The provider-assigned unique ID for this managed resource.
InternalId string
Ref string
NIOS object's reference, not to be set by a user.
id String
The provider-assigned unique ID for this managed resource.
internalId String
ref String
NIOS object's reference, not to be set by a user.
id string
The provider-assigned unique ID for this managed resource.
internalId string
ref string
NIOS object's reference, not to be set by a user.
id str
The provider-assigned unique ID for this managed resource.
internal_id str
ref str
NIOS object's reference, not to be set by a user.
id String
The provider-assigned unique ID for this managed resource.
internalId String
ref String
NIOS object's reference, not to be set by a user.

Look up Existing AliasRecord Resource

Get an existing AliasRecord 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?: AliasRecordState, opts?: CustomResourceOptions): AliasRecord
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        alias_record_id: Optional[str] = None,
        comment: Optional[str] = None,
        disable: Optional[bool] = None,
        dns_view: Optional[str] = None,
        ext_attrs: Optional[str] = None,
        internal_id: Optional[str] = None,
        name: Optional[str] = None,
        ref: Optional[str] = None,
        target_name: Optional[str] = None,
        target_type: Optional[str] = None,
        ttl: Optional[float] = None) -> AliasRecord
func GetAliasRecord(ctx *Context, name string, id IDInput, state *AliasRecordState, opts ...ResourceOption) (*AliasRecord, error)
public static AliasRecord Get(string name, Input<string> id, AliasRecordState? state, CustomResourceOptions? opts = null)
public static AliasRecord get(String name, Output<String> id, AliasRecordState state, CustomResourceOptions options)
resources:  _:    type: infoblox:AliasRecord    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:
AliasRecordId string
Comment string
Comment for the alias record.
Disable bool
A boolean flag which indicates if the alias record is disabled.
DnsView string
Name of the DNS view in which the alias record is created.
ExtAttrs string
Extensible attributes of the Alias Record to be added/updated, as a map in JSON format
InternalId string
Name string
Name of the alias record.
Ref string
NIOS object's reference, not to be set by a user.
TargetName string
Target name in FQDN format.
TargetType string
Type of the target object.
Ttl double
The Time To Live (TTL) value for record. A 32-bit unsigned integer that represents the duration, in seconds, for which the record is valid (cached). Zero indicates that the record should not be cached.
AliasRecordId string
Comment string
Comment for the alias record.
Disable bool
A boolean flag which indicates if the alias record is disabled.
DnsView string
Name of the DNS view in which the alias record is created.
ExtAttrs string
Extensible attributes of the Alias Record to be added/updated, as a map in JSON format
InternalId string
Name string
Name of the alias record.
Ref string
NIOS object's reference, not to be set by a user.
TargetName string
Target name in FQDN format.
TargetType string
Type of the target object.
Ttl float64
The Time To Live (TTL) value for record. A 32-bit unsigned integer that represents the duration, in seconds, for which the record is valid (cached). Zero indicates that the record should not be cached.
aliasRecordId String
comment String
Comment for the alias record.
disable Boolean
A boolean flag which indicates if the alias record is disabled.
dnsView String
Name of the DNS view in which the alias record is created.
extAttrs String
Extensible attributes of the Alias Record to be added/updated, as a map in JSON format
internalId String
name String
Name of the alias record.
ref String
NIOS object's reference, not to be set by a user.
targetName String
Target name in FQDN format.
targetType String
Type of the target object.
ttl Double
The Time To Live (TTL) value for record. A 32-bit unsigned integer that represents the duration, in seconds, for which the record is valid (cached). Zero indicates that the record should not be cached.
aliasRecordId string
comment string
Comment for the alias record.
disable boolean
A boolean flag which indicates if the alias record is disabled.
dnsView string
Name of the DNS view in which the alias record is created.
extAttrs string
Extensible attributes of the Alias Record to be added/updated, as a map in JSON format
internalId string
name string
Name of the alias record.
ref string
NIOS object's reference, not to be set by a user.
targetName string
Target name in FQDN format.
targetType string
Type of the target object.
ttl number
The Time To Live (TTL) value for record. A 32-bit unsigned integer that represents the duration, in seconds, for which the record is valid (cached). Zero indicates that the record should not be cached.
alias_record_id str
comment str
Comment for the alias record.
disable bool
A boolean flag which indicates if the alias record is disabled.
dns_view str
Name of the DNS view in which the alias record is created.
ext_attrs str
Extensible attributes of the Alias Record to be added/updated, as a map in JSON format
internal_id str
name str
Name of the alias record.
ref str
NIOS object's reference, not to be set by a user.
target_name str
Target name in FQDN format.
target_type str
Type of the target object.
ttl float
The Time To Live (TTL) value for record. A 32-bit unsigned integer that represents the duration, in seconds, for which the record is valid (cached). Zero indicates that the record should not be cached.
aliasRecordId String
comment String
Comment for the alias record.
disable Boolean
A boolean flag which indicates if the alias record is disabled.
dnsView String
Name of the DNS view in which the alias record is created.
extAttrs String
Extensible attributes of the Alias Record to be added/updated, as a map in JSON format
internalId String
name String
Name of the alias record.
ref String
NIOS object's reference, not to be set by a user.
targetName String
Target name in FQDN format.
targetType String
Type of the target object.
ttl Number
The Time To Live (TTL) value for record. A 32-bit unsigned integer that represents the duration, in seconds, for which the record is valid (cached). Zero indicates that the record should not be cached.

Package Details

Repository
infoblox infobloxopen/terraform-provider-infoblox
License
Notes
This Pulumi package is based on the infoblox Terraform Provider.
infoblox 2.10.0 published on Friday, Apr 25, 2025 by infobloxopen
infobloxopen/terraform-provider-infoblox