azurermPrivateDnsMxRecord
Enables you to manage DNS MX Records within Azure Private DNS.
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 azurermPrivateDnsZoneExample = new azurerm.privateDnsZone.PrivateDnsZone(
this,
"example_1",
{
name: "contoso.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.*/
azurermPrivateDnsZoneExample.overrideLogicalId("example");
const azurermPrivateDnsMxRecordExample =
new azurerm.privateDnsMxRecord.PrivateDnsMxRecord(this, "example_2", {
name: "example",
record: [
{
exchange: "mx1.contoso.com",
preference: 10,
},
{
exchange: "backupmx.contoso.com",
preference: 20,
},
],
resource_group_name: azurermResourceGroupExample.name,
tags: {
Environment: "Production",
},
ttl: 300,
zone_name: azurermPrivateDnsZoneExample.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.*/
azurermPrivateDnsMxRecordExample.overrideLogicalId("example");
Argument Reference
The following arguments are supported:
-
name- (Optional) The name of the DNS MX Record. Changing this forces a new resource to be created. Default to '@' for root zone entry. -
resourceGroupName- (Required) Specifies the resource group where the resource exists. Changing this forces a new resource to be created. -
zoneName- (Required) Specifies the Private DNS Zone where the resource exists. Changing this forces a new resource to be created. -
record- (Required) One or morerecordblocks as defined below. -
ttl- (Required) The Time To Live (TTL) of the DNS record in seconds. -
tags- (Optional) A mapping of tags to assign to the resource.
A record block supports the following:
-
preference- (Required) The preference of the MX record. -
exchange- (Required) The FQDN of the exchange to MX record points to.
Attributes Reference
The following attributes are exported:
-
id- The Private 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 Private DNS MX Record.update- (Defaults to 30 minutes) Used when updating the Private DNS MX Record.read- (Defaults to 5 minutes) Used when retrieving the Private DNS MX Record.delete- (Defaults to 30 minutes) Used when deleting the Private DNS MX Record.
Import
Private DNS MX Records can be imported using the resourceId, e.g.