@microsoft/terraform-cdk-constructs 1.7.1 → 1.9.0

package/lib/azure-dnszone/lib/records/dns-records.d.ts

@@ -0,0 +1,688 @@
+/**
+ * Azure Public DNS Zone Record implementations using AzapiResource framework
+ *
+ * This file provides implementations for all Public DNS Zone record types:
+ * - DnsARecord (A records with IPv4 addresses)
+ * - DnsAaaaRecord (AAAA records with IPv6 addresses)
+ * - DnsCaaRecord (CAA records for Certificate Authority Authorization) - PUBLIC ONLY
+ * - DnsCnameRecord (CNAME records)
+ * - DnsMxRecord (MX records with exchange and preference)
+ * - DnsNsRecord (NS records for Name Servers) - PUBLIC ONLY
+ * - DnsPtrRecord (PTR records)
+ * - DnsSoaRecord (SOA records)
+ * - DnsSrvRecord (SRV records with priority, weight, port, target)
+ * - DnsTxtRecord (TXT records)
+ *
+ * API Version: 2018-05-01
+ *
+ * Key differences from Private DNS:
+ * - Property casing: Public DNS uses PascalCase (ARecords, TTL vs aRecords, ttl)
+ * - CAA records: Only available in public DNS
+ * - NS records: Only available in public DNS
+ * - targetResource: Public DNS A, AAAA, and CNAME records support alias records
+ */
+import * as cdktf from "cdktf";
+import { Construct } from "constructs";
+import { AzapiResource, AzapiResourceProps } from "../../../core-azure/lib/azapi/azapi-resource";
+import { ApiSchema } from "../../../core-azure/lib/version-manager/interfaces/version-interfaces";
+/**
+ * Base properties shared by all Public DNS record types
+ *
+ * Note: The `name` property is inherited from AzapiResourceProps.
+ * For DNS records, use @ for apex records or provide a relative name like "www" or "mail".
+ */
+export interface DnsRecordBaseProps extends AzapiResourceProps {
+    /**
+     * Resource ID of the parent DNS Zone
+     * @example zone.id or "/subscriptions/.../providers/Microsoft.Network/dnsZones/example.com"
+     */
+    readonly dnsZoneId: string;
+    /**
+     * Time to Live in seconds
+     * @default 3600
+     */
+    readonly ttl?: number;
+    /**
+     * Metadata key-value pairs for the record set
+     */
+    readonly metadata?: {
+        [key: string]: string;
+    };
+}
+/**
+ * Entry for an A record with IPv4 address
+ */
+export interface DnsARecordEntry {
+    /**
+     * The IPv4 address of this A record
+     * @example "20.30.40.50"
+     */
+    readonly ipv4Address: string;
+}
+/**
+ * Properties for Public DNS A Record
+ */
+export interface DnsARecordProps extends DnsRecordBaseProps {
+    /**
+     * Array of A records with IPv4 addresses
+     * Either records or targetResourceId must be specified
+     */
+    readonly records?: DnsARecordEntry[];
+    /**
+     * Reference to an Azure resource from where the IP content is taken (alias record)
+     * Either records or targetResourceId must be specified
+     * @example publicIp.id
+     */
+    readonly targetResourceId?: string;
+}
+/**
+ * Azure Public DNS A Record implementation
+ *
+ * A records map a hostname to one or more IPv4 addresses.
+ * Supports alias records via targetResourceId for pointing to Azure resources.
+ *
+ * @example
+ * // Create an A record with IP addresses:
+ * const aRecord = new DnsARecord(this, "web-a-record", {
+ *   name: "www",
+ *   dnsZoneId: zone.id,
+ *   ttl: 300,
+ *   records: [
+ *     { ipv4Address: "20.30.40.50" },
+ *   ],
+ * });
+ *
+ * @example
+ * // Create an alias A record pointing to an Azure resource:
+ * const aliasRecord = new DnsARecord(this, "alias-a-record", {
+ *   name: "www",
+ *   dnsZoneId: zone.id,
+ *   ttl: 300,
+ *   targetResourceId: publicIp.id,
+ * });
+ *
+ * @stability stable
+ */
+export declare class DnsARecord extends AzapiResource {
+    readonly props: DnsARecordProps;
+    readonly idOutput: cdktf.TerraformOutput;
+    readonly nameOutput: cdktf.TerraformOutput;
+    readonly fqdnOutput: cdktf.TerraformOutput;
+    constructor(scope: Construct, id: string, props: DnsARecordProps);
+    protected resolveParentId(props: any): string;
+    protected defaultVersion(): string;
+    protected resourceType(): string;
+    protected apiSchema(): ApiSchema;
+    protected requiresLocation(): boolean;
+    protected supportsTags(): boolean;
+    protected createResourceBody(props: any): any;
+    /**
+     * Get the FQDN of the record
+     */
+    get fqdn(): string;
+}
+/**
+ * Entry for an AAAA record with IPv6 address
+ */
+export interface DnsAaaaRecordEntry {
+    /**
+     * The IPv6 address of this AAAA record
+     * @example "2001:db8::1"
+     */
+    readonly ipv6Address: string;
+}
+/**
+ * Properties for Public DNS AAAA Record
+ */
+export interface DnsAaaaRecordProps extends DnsRecordBaseProps {
+    /**
+     * Array of AAAA records with IPv6 addresses
+     * Either records or targetResourceId must be specified
+     */
+    readonly records?: DnsAaaaRecordEntry[];
+    /**
+     * Reference to an Azure resource from where the IP content is taken (alias record)
+     * Either records or targetResourceId must be specified
+     */
+    readonly targetResourceId?: string;
+}
+/**
+ * Azure Public DNS AAAA Record implementation
+ *
+ * AAAA records map a hostname to one or more IPv6 addresses.
+ * Supports alias records via targetResourceId for pointing to Azure resources.
+ *
+ * @example
+ * // Create an AAAA record:
+ * const aaaaRecord = new DnsAaaaRecord(this, "web-aaaa-record", {
+ *   name: "www",
+ *   dnsZoneId: zone.id,
+ *   ttl: 300,
+ *   records: [
+ *     { ipv6Address: "2001:db8::1" },
+ *   ],
+ * });
+ *
+ * @stability stable
+ */
+export declare class DnsAaaaRecord extends AzapiResource {
+    readonly props: DnsAaaaRecordProps;
+    readonly idOutput: cdktf.TerraformOutput;
+    readonly nameOutput: cdktf.TerraformOutput;
+    readonly fqdnOutput: cdktf.TerraformOutput;
+    constructor(scope: Construct, id: string, props: DnsAaaaRecordProps);
+    protected resolveParentId(props: any): string;
+    protected defaultVersion(): string;
+    protected resourceType(): string;
+    protected apiSchema(): ApiSchema;
+    protected requiresLocation(): boolean;
+    protected supportsTags(): boolean;
+    protected createResourceBody(props: any): any;
+    /**
+     * Get the FQDN of the record
+     */
+    get fqdn(): string;
+}
+/**
+ * Entry for a CAA record (Certificate Authority Authorization)
+ */
+export interface DnsCaaRecordEntry {
+    /**
+     * Flags for this CAA record (0-255)
+     * 0 = non-critical, 128 = critical
+     * @example 0
+     */
+    readonly flags: number;
+    /**
+     * The property tag for this CAA record
+     * Common values: "issue", "issuewild", "iodef"
+     * @example "issue"
+     */
+    readonly tag: string;
+    /**
+     * The value associated with the tag
+     * @example "letsencrypt.org"
+     */
+    readonly value: string;
+}
+/**
+ * Properties for Public DNS CAA Record
+ */
+export interface DnsCaaRecordProps extends DnsRecordBaseProps {
+    /**
+     * Array of CAA records with flags, tag, and value
+     */
+    readonly records: DnsCaaRecordEntry[];
+}
+/**
+ * Azure Public DNS CAA Record implementation
+ *
+ * CAA records specify which Certificate Authorities are authorized to issue
+ * certificates for a domain. This record type is only available in Public DNS Zones.
+ *
+ * @example
+ * // Create a CAA record to authorize Let's Encrypt:
+ * const caaRecord = new DnsCaaRecord(this, "caa-record", {
+ *   name: "@",
+ *   dnsZoneId: zone.id,
+ *   ttl: 3600,
+ *   records: [
+ *     { flags: 0, tag: "issue", value: "letsencrypt.org" },
+ *     { flags: 0, tag: "issuewild", value: ";" }, // Disallow wildcard certs
+ *     { flags: 0, tag: "iodef", value: "mailto:security@example.com" },
+ *   ],
+ * });
+ *
+ * @stability stable
+ */
+export declare class DnsCaaRecord extends AzapiResource {
+    readonly props: DnsCaaRecordProps;
+    readonly idOutput: cdktf.TerraformOutput;
+    readonly nameOutput: cdktf.TerraformOutput;
+    readonly fqdnOutput: cdktf.TerraformOutput;
+    constructor(scope: Construct, id: string, props: DnsCaaRecordProps);
+    protected resolveParentId(props: any): string;
+    protected defaultVersion(): string;
+    protected resourceType(): string;
+    protected apiSchema(): ApiSchema;
+    protected requiresLocation(): boolean;
+    protected supportsTags(): boolean;
+    protected createResourceBody(props: any): any;
+    /**
+     * Get the FQDN of the record
+     */
+    get fqdn(): string;
+}
+/**
+ * Properties for Public DNS CNAME Record
+ */
+export interface DnsCnameRecordProps extends DnsRecordBaseProps {
+    /**
+     * The canonical name for this CNAME record
+     * Either cname or targetResourceId must be specified
+     * @example "www.contoso.com"
+     */
+    readonly cname?: string;
+    /**
+     * Reference to an Azure resource from where the DNS content is taken (alias record)
+     * Either cname or targetResourceId must be specified
+     */
+    readonly targetResourceId?: string;
+}
+/**
+ * Azure Public DNS CNAME Record implementation
+ *
+ * CNAME records create an alias from one hostname to another.
+ * Supports alias records via targetResourceId for pointing to Azure resources.
+ * Note: CNAME records cannot coexist with other record types at the same name.
+ *
+ * @example
+ * // Create a CNAME record:
+ * const cnameRecord = new DnsCnameRecord(this, "alias-record", {
+ *   name: "app",
+ *   dnsZoneId: zone.id,
+ *   ttl: 3600,
+ *   cname: "www.example.com",
+ * });
+ *
+ * @stability stable
+ */
+export declare class DnsCnameRecord extends AzapiResource {
+    readonly props: DnsCnameRecordProps;
+    readonly idOutput: cdktf.TerraformOutput;
+    readonly nameOutput: cdktf.TerraformOutput;
+    readonly fqdnOutput: cdktf.TerraformOutput;
+    constructor(scope: Construct, id: string, props: DnsCnameRecordProps);
+    protected resolveParentId(props: any): string;
+    protected defaultVersion(): string;
+    protected resourceType(): string;
+    protected apiSchema(): ApiSchema;
+    protected requiresLocation(): boolean;
+    protected supportsTags(): boolean;
+    protected createResourceBody(props: any): any;
+    /**
+     * Get the FQDN of the record
+     */
+    get fqdn(): string;
+}
+/**
+ * Entry for an MX record
+ */
+export interface DnsMxRecordEntry {
+    /**
+     * The preference value for this MX record (lower values have higher priority)
+     * @example 10
+     */
+    readonly preference: number;
+    /**
+     * The mail exchange server hostname
+     * @example "mail1.example.com"
+     */
+    readonly exchange: string;
+}
+/**
+ * Properties for Public DNS MX Record
+ */
+export interface DnsMxRecordProps extends DnsRecordBaseProps {
+    /**
+     * Array of MX records with exchange and preference
+     */
+    readonly records: DnsMxRecordEntry[];
+}
+/**
+ * Azure Public DNS MX Record implementation
+ *
+ * MX records specify mail exchange servers for a domain.
+ *
+ * @example
+ * // Create an MX record:
+ * const mxRecord = new DnsMxRecord(this, "mail-record", {
+ *   name: "@",
+ *   dnsZoneId: zone.id,
+ *   ttl: 3600,
+ *   records: [
+ *     { preference: 10, exchange: "mail1.example.com" },
+ *     { preference: 20, exchange: "mail2.example.com" },
+ *   ],
+ * });
+ *
+ * @stability stable
+ */
+export declare class DnsMxRecord extends AzapiResource {
+    readonly props: DnsMxRecordProps;
+    readonly idOutput: cdktf.TerraformOutput;
+    readonly nameOutput: cdktf.TerraformOutput;
+    readonly fqdnOutput: cdktf.TerraformOutput;
+    constructor(scope: Construct, id: string, props: DnsMxRecordProps);
+    protected resolveParentId(props: any): string;
+    protected defaultVersion(): string;
+    protected resourceType(): string;
+    protected apiSchema(): ApiSchema;
+    protected requiresLocation(): boolean;
+    protected supportsTags(): boolean;
+    protected createResourceBody(props: any): any;
+    /**
+     * Get the FQDN of the record
+     */
+    get fqdn(): string;
+}
+/**
+ * Entry for an NS record
+ */
+export interface DnsNsRecordEntry {
+    /**
+     * The name server domain name
+     * @example "ns1.example.com"
+     */
+    readonly nsdname: string;
+}
+/**
+ * Properties for Public DNS NS Record
+ */
+export interface DnsNsRecordProps extends DnsRecordBaseProps {
+    /**
+     * Array of NS records with nsdname values
+     */
+    readonly records: DnsNsRecordEntry[];
+}
+/**
+ * Azure Public DNS NS Record implementation
+ *
+ * NS records specify the authoritative name servers for a domain or subdomain.
+ * This record type is only available in Public DNS Zones.
+ *
+ * @example
+ * // Create an NS record for a subdomain delegation:
+ * const nsRecord = new DnsNsRecord(this, "ns-record", {
+ *   name: "subdomain",
+ *   dnsZoneId: zone.id,
+ *   ttl: 3600,
+ *   records: [
+ *     { nsdname: "ns1.subdomain.example.com" },
+ *     { nsdname: "ns2.subdomain.example.com" },
+ *   ],
+ * });
+ *
+ * @stability stable
+ */
+export declare class DnsNsRecord extends AzapiResource {
+    readonly props: DnsNsRecordProps;
+    readonly idOutput: cdktf.TerraformOutput;
+    readonly nameOutput: cdktf.TerraformOutput;
+    readonly fqdnOutput: cdktf.TerraformOutput;
+    constructor(scope: Construct, id: string, props: DnsNsRecordProps);
+    protected resolveParentId(props: any): string;
+    protected defaultVersion(): string;
+    protected resourceType(): string;
+    protected apiSchema(): ApiSchema;
+    protected requiresLocation(): boolean;
+    protected supportsTags(): boolean;
+    protected createResourceBody(props: any): any;
+    /**
+     * Get the FQDN of the record
+     */
+    get fqdn(): string;
+}
+/**
+ * Entry for a PTR record
+ */
+export interface DnsPtrRecordEntry {
+    /**
+     * The PTR target domain name
+     * @example "server1.example.com"
+     */
+    readonly ptrdname: string;
+}
+/**
+ * Properties for Public DNS PTR Record
+ */
+export interface DnsPtrRecordProps extends DnsRecordBaseProps {
+    /**
+     * Array of PTR records with ptrdname values
+     */
+    readonly records: DnsPtrRecordEntry[];
+}
+/**
+ * Azure Public DNS PTR Record implementation
+ *
+ * PTR records are used for reverse DNS lookups, mapping IP addresses to hostnames.
+ *
+ * @example
+ * // Create a PTR record:
+ * const ptrRecord = new DnsPtrRecord(this, "ptr-record", {
+ *   name: "50",
+ *   dnsZoneId: reverseZone.id,
+ *   ttl: 3600,
+ *   records: [
+ *     { ptrdname: "server1.example.com" },
+ *   ],
+ * });
+ *
+ * @stability stable
+ */
+export declare class DnsPtrRecord extends AzapiResource {
+    readonly props: DnsPtrRecordProps;
+    readonly idOutput: cdktf.TerraformOutput;
+    readonly nameOutput: cdktf.TerraformOutput;
+    readonly fqdnOutput: cdktf.TerraformOutput;
+    constructor(scope: Construct, id: string, props: DnsPtrRecordProps);
+    protected resolveParentId(props: any): string;
+    protected defaultVersion(): string;
+    protected resourceType(): string;
+    protected apiSchema(): ApiSchema;
+    protected requiresLocation(): boolean;
+    protected supportsTags(): boolean;
+    protected createResourceBody(props: any): any;
+    /**
+     * Get the FQDN of the record
+     */
+    get fqdn(): string;
+}
+/**
+ * SOA record configuration
+ */
+export interface DnsSoaRecordConfig {
+    /**
+     * The domain name of the authoritative name server
+     */
+    readonly host?: string;
+    /**
+     * The email contact for this zone (with @ replaced by .)
+     * @example "admin.example.com" (for admin@example.com)
+     */
+    readonly email?: string;
+    /**
+     * The serial number for this zone
+     */
+    readonly serialNumber?: number;
+    /**
+     * The refresh time in seconds
+     */
+    readonly refreshTime?: number;
+    /**
+     * The retry time in seconds
+     */
+    readonly retryTime?: number;
+    /**
+     * The expire time in seconds
+     */
+    readonly expireTime?: number;
+    /**
+     * The minimum TTL in seconds
+     */
+    readonly minimumTTL?: number;
+}
+/**
+ * Properties for Public DNS SOA Record
+ */
+export interface DnsSoaRecordProps extends DnsRecordBaseProps {
+    /**
+     * SOA record configuration
+     */
+    readonly soaRecord: DnsSoaRecordConfig;
+}
+/**
+ * Azure Public DNS SOA Record implementation
+ *
+ * SOA records contain administrative information about a DNS zone.
+ * Note: Each zone automatically has an SOA record; this is typically used to update it.
+ *
+ * @example
+ * // Update the SOA record:
+ * const soaRecord = new DnsSoaRecord(this, "soa-record", {
+ *   name: "@",
+ *   dnsZoneId: zone.id,
+ *   ttl: 3600,
+ *   soaRecord: {
+ *     email: "admin.example.com",
+ *     refreshTime: 3600,
+ *     retryTime: 300,
+ *     expireTime: 2419200,
+ *     minimumTTL: 300,
+ *   },
+ * });
+ *
+ * @stability stable
+ */
+export declare class DnsSoaRecord extends AzapiResource {
+    readonly props: DnsSoaRecordProps;
+    readonly idOutput: cdktf.TerraformOutput;
+    readonly nameOutput: cdktf.TerraformOutput;
+    readonly fqdnOutput: cdktf.TerraformOutput;
+    constructor(scope: Construct, id: string, props: DnsSoaRecordProps);
+    protected resolveParentId(props: any): string;
+    protected defaultVersion(): string;
+    protected resourceType(): string;
+    protected apiSchema(): ApiSchema;
+    protected requiresLocation(): boolean;
+    protected supportsTags(): boolean;
+    protected createResourceBody(props: any): any;
+    /**
+     * Get the FQDN of the record
+     */
+    get fqdn(): string;
+}
+/**
+ * Entry for an SRV record
+ */
+export interface DnsSrvRecordEntry {
+    /**
+     * The priority of this SRV record (lower values have higher priority)
+     */
+    readonly priority: number;
+    /**
+     * The weight of this SRV record (used for load balancing among records with same priority)
+     */
+    readonly weight: number;
+    /**
+     * The port number for the service
+     */
+    readonly port: number;
+    /**
+     * The target hostname providing the service
+     * @example "sipserver.example.com"
+     */
+    readonly target: string;
+}
+/**
+ * Properties for Public DNS SRV Record
+ */
+export interface DnsSrvRecordProps extends DnsRecordBaseProps {
+    /**
+     * Array of SRV records with priority, weight, port, and target
+     */
+    readonly records: DnsSrvRecordEntry[];
+}
+/**
+ * Azure Public DNS SRV Record implementation
+ *
+ * SRV records specify the location of services like SIP, XMPP, etc.
+ *
+ * @example
+ * // Create an SRV record for a SIP service:
+ * const srvRecord = new DnsSrvRecord(this, "sip-record", {
+ *   name: "_sip._tcp",
+ *   dnsZoneId: zone.id,
+ *   ttl: 3600,
+ *   records: [
+ *     { priority: 10, weight: 60, port: 5060, target: "sipserver1.example.com" },
+ *     { priority: 10, weight: 40, port: 5060, target: "sipserver2.example.com" },
+ *   ],
+ * });
+ *
+ * @stability stable
+ */
+export declare class DnsSrvRecord extends AzapiResource {
+    readonly props: DnsSrvRecordProps;
+    readonly idOutput: cdktf.TerraformOutput;
+    readonly nameOutput: cdktf.TerraformOutput;
+    readonly fqdnOutput: cdktf.TerraformOutput;
+    constructor(scope: Construct, id: string, props: DnsSrvRecordProps);
+    protected resolveParentId(props: any): string;
+    protected defaultVersion(): string;
+    protected resourceType(): string;
+    protected apiSchema(): ApiSchema;
+    protected requiresLocation(): boolean;
+    protected supportsTags(): boolean;
+    protected createResourceBody(props: any): any;
+    /**
+     * Get the FQDN of the record
+     */
+    get fqdn(): string;
+}
+/**
+ * Entry for a TXT record
+ */
+export interface DnsTxtRecordEntry {
+    /**
+     * The text value of this TXT record (array of strings, each up to 255 chars)
+     * Long values are automatically split into multiple strings
+     * @example ["v=spf1 include:spf.protection.outlook.com -all"]
+     */
+    readonly value: string[];
+}
+/**
+ * Properties for Public DNS TXT Record
+ */
+export interface DnsTxtRecordProps extends DnsRecordBaseProps {
+    /**
+     * Array of TXT records with string values
+     */
+    readonly records: DnsTxtRecordEntry[];
+}
+/**
+ * Azure Public DNS TXT Record implementation
+ *
+ * TXT records store arbitrary text data, commonly used for SPF, DKIM, domain verification, etc.
+ *
+ * @example
+ * // Create a TXT record for SPF:
+ * const txtRecord = new DnsTxtRecord(this, "spf-record", {
+ *   name: "@",
+ *   dnsZoneId: zone.id,
+ *   ttl: 3600,
+ *   records: [
+ *     { value: ["v=spf1 include:spf.protection.outlook.com -all"] },
+ *   ],
+ * });
+ *
+ * @stability stable
+ */
+export declare class DnsTxtRecord extends AzapiResource {
+    readonly props: DnsTxtRecordProps;
+    readonly idOutput: cdktf.TerraformOutput;
+    readonly nameOutput: cdktf.TerraformOutput;
+    readonly fqdnOutput: cdktf.TerraformOutput;
+    constructor(scope: Construct, id: string, props: DnsTxtRecordProps);
+    protected resolveParentId(props: any): string;
+    protected defaultVersion(): string;
+    protected resourceType(): string;
+    protected apiSchema(): ApiSchema;
+    protected requiresLocation(): boolean;
+    protected supportsTags(): boolean;
+    protected createResourceBody(props: any): any;
+    /**
+     * Get the FQDN of the record
+     */
+    get fqdn(): string;
+}