azurermDnsMxRecord
Enables you to manage DNS MX Records within Azure DNS.
\~> Note: The Azure DNS API has a throttle limit of 500 read (GET) operations per 5 minutes - whilst the default read timeouts will work for most cases - in larger configurations you may need to set a larger read timeout then the default 5min. Although, we'd generally recommend that you split the resources out into smaller Terraform configurations to avoid the problem entirely.
Example Usage
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as azurerm from "./.gen/providers/azurerm";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: azurerm.
For a more precise conversion please use the --provider flag in convert.*/
const azurermResourceGroupExample = new azurerm.resourceGroup.ResourceGroup(
this,
"example",
{
location: "West Europe",
name: "example-resources",
}
);
const azurermDnsZoneExample = new azurerm.dnsZone.DnsZone(this, "example_1", {
name: "mydomain.com",
resource_group_name: azurermResourceGroupExample.name,
});
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermDnsZoneExample.overrideLogicalId("example");
const azurermDnsMxRecordExample = new azurerm.dnsMxRecord.DnsMxRecord(
this,
"example_2",
{
name: "test",
record: [
{
exchange: "mail1.contoso.com",
preference: 10,
},
{
exchange: "mail2.contoso.com",
preference: 20,
},
],
resource_group_name: azurermResourceGroupExample.name,
tags: {
Environment: "Production",
},
ttl: 300,
zone_name: azurermDnsZoneExample.name,
}
);
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermDnsMxRecordExample.overrideLogicalId("example");
Argument Reference
The following arguments are supported:
-
name- (Optional) The name of the DNS MX Record. Defaults to@(root). Changing this forces a new resource to be created. -
resourceGroupName- (Required) Specifies the resource group where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created. -
zoneName- (Required) Specifies the DNS Zone where the resource exists. Changing this forces a new resource to be created. -
ttl- (Required) The Time To Live (TTL) of the DNS record in seconds. -
record- (Required) A list of values that make up the MX record. Eachrecordblock supports fields documented below. -
tags- (Optional) A mapping of tags to assign to the resource.
The record block supports:
-
preference- (Required) String representing the "preference” value of the MX records. Records with lower preference value take priority. -
exchange- (Required) The mail server responsible for the domain covered by the MX record.
Attributes Reference
The following attributes are exported:
-
id- The DNS MX Record ID. -
fqdn- The FQDN of the DNS MX Record.
Timeouts
The timeouts block allows you to specify timeouts for certain actions:
-
create- (Defaults to 30 minutes) Used when creating the DNS MX Record. -
update- (Defaults to 30 minutes) Used when updating the DNS MX Record. -
read- (Defaults to 5 minutes) Used when retrieving the DNS MX Record. -
delete- (Defaults to 30 minutes) Used when deleting the DNS MX Record.
Import
MX records can be imported using the resourceId, e.g.