@microsoft/terraform-cdk-constructs 1.7.1 → 1.9.0

package/lib/azure-privatednszone/lib/records/private-dns-records.d.ts

@@ -0,0 +1,523 @@
+/**
+ * Azure Private DNS Zone Record implementations using AzapiResource framework
+ *
+ * This file provides implementations for all Private DNS Zone record types:
+ * - PrivateDnsARecord (A records with IPv4 addresses)
+ * - PrivateDnsAaaaRecord (AAAA records with IPv6 addresses)
+ * - PrivateDnsCnameRecord (CNAME records)
+ * - PrivateDnsMxRecord (MX records with exchange and preference)
+ * - PrivateDnsPtrRecord (PTR records)
+ * - PrivateDnsSoaRecord (SOA records)
+ * - PrivateDnsSrvRecord (SRV records with priority, weight, port, target)
+ * - PrivateDnsTxtRecord (TXT records)
+ *
+ * API Version: 2024-06-01
+ */
+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 Private 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 PrivateDnsRecordBaseProps extends AzapiResourceProps {
+    /**
+     * Resource ID of the parent Private DNS Zone
+     * @example zone.id or "/subscriptions/.../providers/Microsoft.Network/privateDnsZones/example.com"
+     */
+    readonly privateDnsZoneId: 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 ARecordEntry {
+    /**
+     * The IPv4 address of this A record
+     * @example "10.0.1.4"
+     */
+    readonly ipv4Address: string;
+}
+/**
+ * Properties for Private DNS A Record
+ */
+export interface PrivateDnsARecordProps extends PrivateDnsRecordBaseProps {
+    /**
+     * Array of A records with IPv4 addresses
+     */
+    readonly records: ARecordEntry[];
+}
+/**
+ * Azure Private DNS A Record implementation
+ *
+ * A records map a hostname to one or more IPv4 addresses.
+ *
+ * @example
+ * // Create an A record with multiple IP addresses:
+ * const aRecord = new PrivateDnsARecord(this, "web-a-record", {
+ *   name: "www",
+ *   privateDnsZoneId: zone.id,
+ *   ttl: 300,
+ *   records: [
+ *     { ipv4Address: "10.0.1.4" },
+ *     { ipv4Address: "10.0.1.5" },
+ *   ],
+ * });
+ *
+ * @stability stable
+ */
+export declare class PrivateDnsARecord extends AzapiResource {
+    readonly props: PrivateDnsARecordProps;
+    readonly idOutput: cdktf.TerraformOutput;
+    readonly nameOutput: cdktf.TerraformOutput;
+    readonly fqdnOutput: cdktf.TerraformOutput;
+    constructor(scope: Construct, id: string, props: PrivateDnsARecordProps);
+    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 AaaaRecordEntry {
+    /**
+     * The IPv6 address of this AAAA record
+     * @example "2001:db8::1"
+     */
+    readonly ipv6Address: string;
+}
+/**
+ * Properties for Private DNS AAAA Record
+ */
+export interface PrivateDnsAaaaRecordProps extends PrivateDnsRecordBaseProps {
+    /**
+     * Array of AAAA records with IPv6 addresses
+     */
+    readonly records: AaaaRecordEntry[];
+}
+/**
+ * Azure Private DNS AAAA Record implementation
+ *
+ * AAAA records map a hostname to one or more IPv6 addresses.
+ *
+ * @example
+ * // Create an AAAA record:
+ * const aaaaRecord = new PrivateDnsAaaaRecord(this, "web-aaaa-record", {
+ *   name: "www",
+ *   privateDnsZoneId: zone.id,
+ *   ttl: 300,
+ *   records: [
+ *     { ipv6Address: "2001:db8::1" },
+ *   ],
+ * });
+ *
+ * @stability stable
+ */
+export declare class PrivateDnsAaaaRecord extends AzapiResource {
+    readonly props: PrivateDnsAaaaRecordProps;
+    readonly idOutput: cdktf.TerraformOutput;
+    readonly nameOutput: cdktf.TerraformOutput;
+    readonly fqdnOutput: cdktf.TerraformOutput;
+    constructor(scope: Construct, id: string, props: PrivateDnsAaaaRecordProps);
+    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 Private DNS CNAME Record
+ */
+export interface PrivateDnsCnameRecordProps extends PrivateDnsRecordBaseProps {
+    /**
+     * The canonical name for this CNAME record
+     * @example "www.contoso.com"
+     */
+    readonly cname: string;
+}
+/**
+ * Azure Private DNS CNAME Record implementation
+ *
+ * CNAME records create an alias from one hostname to another.
+ * Note: CNAME records cannot coexist with other record types at the same name.
+ *
+ * @example
+ * // Create a CNAME record:
+ * const cnameRecord = new PrivateDnsCnameRecord(this, "alias-record", {
+ *   name: "app",
+ *   privateDnsZoneId: zone.id,
+ *   ttl: 3600,
+ *   cname: "www.internal.example.com",
+ * });
+ *
+ * @stability stable
+ */
+export declare class PrivateDnsCnameRecord extends AzapiResource {
+    readonly props: PrivateDnsCnameRecordProps;
+    readonly idOutput: cdktf.TerraformOutput;
+    readonly nameOutput: cdktf.TerraformOutput;
+    readonly fqdnOutput: cdktf.TerraformOutput;
+    constructor(scope: Construct, id: string, props: PrivateDnsCnameRecordProps);
+    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 MxRecordEntry {
+    /**
+     * 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 Private DNS MX Record
+ */
+export interface PrivateDnsMxRecordProps extends PrivateDnsRecordBaseProps {
+    /**
+     * Array of MX records with exchange and preference
+     */
+    readonly records: MxRecordEntry[];
+}
+/**
+ * Azure Private DNS MX Record implementation
+ *
+ * MX records specify mail exchange servers for a domain.
+ *
+ * @example
+ * // Create an MX record:
+ * const mxRecord = new PrivateDnsMxRecord(this, "mail-record", {
+ *   name: "@",
+ *   privateDnsZoneId: zone.id,
+ *   ttl: 3600,
+ *   records: [
+ *     { preference: 10, exchange: "mail1.internal.example.com" },
+ *     { preference: 20, exchange: "mail2.internal.example.com" },
+ *   ],
+ * });
+ *
+ * @stability stable
+ */
+export declare class PrivateDnsMxRecord extends AzapiResource {
+    readonly props: PrivateDnsMxRecordProps;
+    readonly idOutput: cdktf.TerraformOutput;
+    readonly nameOutput: cdktf.TerraformOutput;
+    readonly fqdnOutput: cdktf.TerraformOutput;
+    constructor(scope: Construct, id: string, props: PrivateDnsMxRecordProps);
+    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 PtrRecordEntry {
+    /**
+     * The PTR target domain name
+     * @example "server1.internal.example.com"
+     */
+    readonly ptrdname: string;
+}
+/**
+ * Properties for Private DNS PTR Record
+ */
+export interface PrivateDnsPtrRecordProps extends PrivateDnsRecordBaseProps {
+    /**
+     * Array of PTR records with ptrdname values
+     */
+    readonly records: PtrRecordEntry[];
+}
+/**
+ * Azure Private 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 PrivateDnsPtrRecord(this, "ptr-record", {
+ *   name: "4.1.0.10.in-addr.arpa",
+ *   privateDnsZoneId: reverseZone.id,
+ *   ttl: 3600,
+ *   records: [
+ *     { ptrdname: "server1.internal.example.com" },
+ *   ],
+ * });
+ *
+ * @stability stable
+ */
+export declare class PrivateDnsPtrRecord extends AzapiResource {
+    readonly props: PrivateDnsPtrRecordProps;
+    readonly idOutput: cdktf.TerraformOutput;
+    readonly nameOutput: cdktf.TerraformOutput;
+    readonly fqdnOutput: cdktf.TerraformOutput;
+    constructor(scope: Construct, id: string, props: PrivateDnsPtrRecordProps);
+    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 SoaRecordConfig {
+    /**
+     * 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 Private DNS SOA Record
+ */
+export interface PrivateDnsSoaRecordProps extends PrivateDnsRecordBaseProps {
+    /**
+     * SOA record configuration
+     */
+    readonly soaRecord: SoaRecordConfig;
+}
+/**
+ * Azure Private 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 PrivateDnsSoaRecord(this, "soa-record", {
+ *   name: "@",
+ *   privateDnsZoneId: zone.id,
+ *   ttl: 3600,
+ *   soaRecord: {
+ *     email: "admin.example.com",
+ *     refreshTime: 3600,
+ *     retryTime: 300,
+ *     expireTime: 2419200,
+ *     minimumTtl: 300,
+ *   },
+ * });
+ *
+ * @stability stable
+ */
+export declare class PrivateDnsSoaRecord extends AzapiResource {
+    readonly props: PrivateDnsSoaRecordProps;
+    readonly idOutput: cdktf.TerraformOutput;
+    readonly nameOutput: cdktf.TerraformOutput;
+    readonly fqdnOutput: cdktf.TerraformOutput;
+    constructor(scope: Construct, id: string, props: PrivateDnsSoaRecordProps);
+    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 SrvRecordEntry {
+    /**
+     * 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.internal.example.com"
+     */
+    readonly target: string;
+}
+/**
+ * Properties for Private DNS SRV Record
+ */
+export interface PrivateDnsSrvRecordProps extends PrivateDnsRecordBaseProps {
+    /**
+     * Array of SRV records with priority, weight, port, and target
+     */
+    readonly records: SrvRecordEntry[];
+}
+/**
+ * Azure Private 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 PrivateDnsSrvRecord(this, "sip-record", {
+ *   name: "_sip._tcp",
+ *   privateDnsZoneId: zone.id,
+ *   ttl: 3600,
+ *   records: [
+ *     { priority: 10, weight: 60, port: 5060, target: "sipserver1.internal.example.com" },
+ *     { priority: 10, weight: 40, port: 5060, target: "sipserver2.internal.example.com" },
+ *   ],
+ * });
+ *
+ * @stability stable
+ */
+export declare class PrivateDnsSrvRecord extends AzapiResource {
+    readonly props: PrivateDnsSrvRecordProps;
+    readonly idOutput: cdktf.TerraformOutput;
+    readonly nameOutput: cdktf.TerraformOutput;
+    readonly fqdnOutput: cdktf.TerraformOutput;
+    constructor(scope: Construct, id: string, props: PrivateDnsSrvRecordProps);
+    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 TxtRecordEntry {
+    /**
+     * 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 Private DNS TXT Record
+ */
+export interface PrivateDnsTxtRecordProps extends PrivateDnsRecordBaseProps {
+    /**
+     * Array of TXT records with string values
+     */
+    readonly records: TxtRecordEntry[];
+}
+/**
+ * Azure Private DNS TXT Record implementation
+ *
+ * TXT records store arbitrary text data, commonly used for SPF, DKIM, etc.
+ *
+ * @example
+ * // Create a TXT record for SPF:
+ * const txtRecord = new PrivateDnsTxtRecord(this, "spf-record", {
+ *   name: "@",
+ *   privateDnsZoneId: zone.id,
+ *   ttl: 3600,
+ *   records: [
+ *     { value: ["v=spf1 include:spf.protection.outlook.com -all"] },
+ *   ],
+ * });
+ *
+ * @stability stable
+ */
+export declare class PrivateDnsTxtRecord extends AzapiResource {
+    readonly props: PrivateDnsTxtRecordProps;
+    readonly idOutput: cdktf.TerraformOutput;
+    readonly nameOutput: cdktf.TerraformOutput;
+    readonly fqdnOutput: cdktf.TerraformOutput;
+    constructor(scope: Construct, id: string, props: PrivateDnsTxtRecordProps);
+    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;
+}