azurermDnsCnameRecord

Enables you to manage DNS CNAME 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 azurermDnsCnameRecordExample = new azurerm.dnsCnameRecord.DnsCnameRecord(
  this,
  "example_2",
  {
    name: "test",
    record: "contoso.com",
    resource_group_name: azurermResourceGroupExample.name,
    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.*/
azurermDnsCnameRecordExample.overrideLogicalId("example");

Example Usage (Alias Record)

/*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 azurermDnsCnameRecordTarget = new azurerm.dnsCnameRecord.DnsCnameRecord(
  this,
  "target",
  {
    name: "target",
    record: "contoso.com",
    resource_group_name: azurermResourceGroupExample.name,
    ttl: 300,
    zone_name: azurermDnsZoneExample.name,
  }
);
const azurermDnsCnameRecordExample = new azurerm.dnsCnameRecord.DnsCnameRecord(
  this,
  "example_3",
  {
    name: "test",
    resource_group_name: azurermResourceGroupExample.name,
    target_resource_id: azurermDnsCnameRecordTarget.id,
    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.*/
azurermDnsCnameRecordExample.overrideLogicalId("example");

Argument Reference

The following arguments are supported:

name - (Required) The name of the DNS CNAME Record. 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 - (Optional) The target of the CNAME.
targetResourceId - (Optional) The Azure resource id of the target object. Conflicts with record.
tags - (Optional) A mapping of tags to assign to the resource.

\~> Note: either record OR targetResourceId must be specified, but not both.

Attributes Reference

The following attributes are exported:

id - The DNS CName Record ID.
fqdn - The FQDN of the DNS CName Record.

\~> Note: The FQDN of the DNS CNAME Record which has a full-stop at the end is by design. Please see the documentation for more information.

Timeouts

The timeouts block allows you to specify timeouts for certain actions:

create - (Defaults to 30 minutes) Used when creating the DNS CNAME Record.
update - (Defaults to 30 minutes) Used when updating the DNS CNAME Record.
read - (Defaults to 5 minutes) Used when retrieving the DNS CNAME Record.
delete - (Defaults to 30 minutes) Used when deleting the DNS CNAME Record.

Import

CNAME records can be imported using the resourceId, e.g.

terraform import azurerm_dns_cname_record.example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Network/dnsZones/zone1/CNAME/myrecord1