@microsoft/terraform-cdk-constructs 1.4.0 → 1.5.0

package/lib/azure-virtualnetworkgateway/lib/virtual-network-gateway.d.ts

@@ -0,0 +1,368 @@
+/**
+ * Azure Virtual Network Gateway implementation using AzapiResource framework
+ *
+ * This class provides a unified implementation for Azure Virtual Network Gateways that
+ * automatically handles version management, schema validation, and property
+ * transformation across all supported API versions.
+ *
+ * Supported API Versions:
+ * - 2024-01-01 (Active)
+ * - 2024-05-01 (Active, Latest)
+ *
+ * Features:
+ * - Automatic latest version resolution when no version is specified
+ * - Explicit version pinning for stability requirements
+ * - Schema-driven validation and transformation
+ * - Full backward compatibility
+ * - JSII compliance for multi-language support
+ */
+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";
+/**
+ * SKU configuration for Virtual Network Gateway
+ */
+export interface VirtualNetworkGatewaySku {
+    /**
+     * Name of the SKU
+     * @example "Basic", "VpnGw1", "VpnGw2", "VpnGw3", "VpnGw4", "VpnGw5", "ErGw1AZ", "ErGw2AZ", "ErGw3AZ"
+     */
+    readonly name: string;
+    /**
+     * Tier of the SKU
+     * @example "Basic", "VpnGw1", "VpnGw2", "VpnGw3", "VpnGw4", "VpnGw5", "ErGw1AZ", "ErGw2AZ", "ErGw3AZ"
+     */
+    readonly tier: string;
+}
+/**
+ * IP configuration for Virtual Network Gateway
+ */
+export interface VirtualNetworkGatewayIpConfiguration {
+    /**
+     * Name of the IP configuration
+     */
+    readonly name: string;
+    /**
+     * Private IP allocation method
+     * @defaultValue "Dynamic"
+     */
+    readonly privateIPAllocationMethod?: string;
+    /**
+     * ID of the subnet to use (must be GatewaySubnet)
+     */
+    readonly subnetId: string;
+    /**
+     * ID of the public IP address to use
+     */
+    readonly publicIPAddressId: string;
+}
+/**
+ * BGP settings for Virtual Network Gateway
+ */
+export interface VirtualNetworkGatewayBgpSettings {
+    /**
+     * BGP ASN (Autonomous System Number)
+     * @example 65515
+     */
+    readonly asn?: number;
+    /**
+     * BGP peering address
+     */
+    readonly bgpPeeringAddress?: string;
+    /**
+     * Weight added to routes learned from this BGP speaker
+     */
+    readonly peerWeight?: number;
+    /**
+     * BGP peering addresses for active-active configuration
+     */
+    readonly bgpPeeringAddresses?: any[];
+}
+/**
+ * VPN client address pool configuration
+ */
+export interface VirtualNetworkGatewayVpnClientAddressPool {
+    /**
+     * List of address prefixes for VPN client connections
+     */
+    readonly addressPrefixes: string[];
+}
+/**
+ * VPN client configuration for point-to-site connections
+ */
+export interface VirtualNetworkGatewayVpnClientConfiguration {
+    /**
+     * VPN client address pool
+     */
+    readonly vpnClientAddressPool?: VirtualNetworkGatewayVpnClientAddressPool;
+    /**
+     * VPN client protocols
+     * @example ["IkeV2", "SSTP", "OpenVPN"]
+     */
+    readonly vpnClientProtocols?: string[];
+    /**
+     * VPN client root certificates
+     */
+    readonly vpnClientRootCertificates?: any[];
+    /**
+     * VPN client revoked certificates
+     */
+    readonly vpnClientRevokedCertificates?: any[];
+    /**
+     * Radius server address
+     */
+    readonly radiusServerAddress?: string;
+    /**
+     * Radius server secret
+     */
+    readonly radiusServerSecret?: string;
+}
+/**
+ * Custom routes configuration
+ */
+export interface VirtualNetworkGatewayCustomRoutes {
+    /**
+     * List of address prefixes
+     */
+    readonly addressPrefixes?: string[];
+}
+/**
+ * Gateway default site reference
+ */
+export interface VirtualNetworkGatewayDefaultSite {
+    /**
+     * Resource ID of the local network gateway to use as default site
+     */
+    readonly id: string;
+}
+/**
+ * Properties for the Azure Virtual Network Gateway
+ *
+ * Extends AzapiResourceProps with Virtual Network Gateway specific properties
+ */
+export interface VirtualNetworkGatewayProps extends AzapiResourceProps {
+    /**
+     * Gateway type
+     * Must be either "Vpn" or "ExpressRoute"
+     */
+    readonly gatewayType: "Vpn" | "ExpressRoute";
+    /**
+     * VPN type for VPN gateways
+     * @defaultValue "RouteBased"
+     */
+    readonly vpnType?: "RouteBased" | "PolicyBased";
+    /**
+     * SKU configuration for the gateway
+     */
+    readonly sku: VirtualNetworkGatewaySku;
+    /**
+     * IP configurations for the gateway
+     * At least one IP configuration is required
+     * Two IP configurations are required for active-active mode
+     */
+    readonly ipConfigurations: VirtualNetworkGatewayIpConfiguration[];
+    /**
+     * Enable BGP for the gateway
+     * @defaultValue false
+     */
+    readonly enableBgp?: boolean;
+    /**
+     * Enable active-active mode for the gateway
+     * Requires two IP configurations
+     * @defaultValue false
+     */
+    readonly activeActive?: boolean;
+    /**
+     * BGP settings for the gateway
+     * Required if enableBgp is true
+     */
+    readonly bgpSettings?: VirtualNetworkGatewayBgpSettings;
+    /**
+     * VPN gateway generation
+     * @example "Generation1", "Generation2"
+     */
+    readonly vpnGatewayGeneration?: string;
+    /**
+     * Custom routes for the gateway
+     */
+    readonly customRoutes?: VirtualNetworkGatewayCustomRoutes;
+    /**
+     * Enable private IP address for the gateway
+     * @defaultValue false
+     */
+    readonly enablePrivateIpAddress?: boolean;
+    /**
+     * Default site for force tunneling
+     */
+    readonly gatewayDefaultSite?: VirtualNetworkGatewayDefaultSite;
+    /**
+     * VPN client configuration for point-to-site connections
+     */
+    readonly vpnClientConfiguration?: VirtualNetworkGatewayVpnClientConfiguration;
+    /**
+     * Resource group ID where the Gateway will be created
+     * Optional - will use the subscription scope if not provided
+     */
+    readonly resourceGroupId?: string;
+    /**
+     * The lifecycle rules to ignore changes
+     * Useful for properties that are externally managed
+     *
+     * @example ["tags"]
+     */
+    readonly ignoreChanges?: string[];
+}
+/**
+ * Azure Virtual Network Gateway implementation
+ *
+ * This class provides a single, version-aware implementation that replaces
+ * version-specific Virtual Network Gateway classes. It automatically handles version
+ * resolution, schema validation, and property transformation while maintaining
+ * full backward compatibility.
+ *
+ * Virtual Network Gateways are used to send encrypted traffic between Azure virtual
+ * networks and on-premises locations over the public Internet (VPN) or through
+ * Azure ExpressRoute circuits (ExpressRoute).
+ *
+ * @example
+ * // Basic VPN Gateway:
+ * const vpnGateway = new VirtualNetworkGateway(this, "vpnGateway", {
+ *   name: "my-vpn-gateway",
+ *   location: "eastus",
+ *   resourceGroupId: resourceGroup.id,
+ *   gatewayType: "Vpn",
+ *   vpnType: "RouteBased",
+ *   sku: {
+ *     name: "VpnGw1",
+ *     tier: "VpnGw1"
+ *   },
+ *   ipConfigurations: [{
+ *     name: "default",
+ *     subnetId: gatewaySubnet.id,
+ *     publicIPAddressId: publicIp.id
+ *   }]
+ * });
+ *
+ * @example
+ * // VPN Gateway with BGP:
+ * const vpnGateway = new VirtualNetworkGateway(this, "vpnGateway", {
+ *   name: "my-vpn-gateway-bgp",
+ *   location: "eastus",
+ *   resourceGroupId: resourceGroup.id,
+ *   gatewayType: "Vpn",
+ *   vpnType: "RouteBased",
+ *   sku: {
+ *     name: "VpnGw1",
+ *     tier: "VpnGw1"
+ *   },
+ *   enableBgp: true,
+ *   bgpSettings: {
+ *     asn: 65515,
+ *     peerWeight: 0
+ *   },
+ *   ipConfigurations: [{
+ *     name: "default",
+ *     subnetId: gatewaySubnet.id,
+ *     publicIPAddressId: publicIp.id
+ *   }]
+ * });
+ *
+ * @example
+ * // Active-Active VPN Gateway:
+ * const vpnGateway = new VirtualNetworkGateway(this, "vpnGateway", {
+ *   name: "my-vpn-gateway-aa",
+ *   location: "eastus",
+ *   resourceGroupId: resourceGroup.id,
+ *   gatewayType: "Vpn",
+ *   vpnType: "RouteBased",
+ *   sku: {
+ *     name: "VpnGw1",
+ *     tier: "VpnGw1"
+ *   },
+ *   activeActive: true,
+ *   ipConfigurations: [
+ *     {
+ *       name: "config1",
+ *       subnetId: gatewaySubnet.id,
+ *       publicIPAddressId: publicIp1.id
+ *     },
+ *     {
+ *       name: "config2",
+ *       subnetId: gatewaySubnet.id,
+ *       publicIPAddressId: publicIp2.id
+ *     }
+ *   ]
+ * });
+ *
+ * @stability stable
+ */
+export declare class VirtualNetworkGateway extends AzapiResource {
+    /**
+     * The input properties for this Virtual Network Gateway instance
+     */
+    readonly props: VirtualNetworkGatewayProps;
+    readonly idOutput: cdktf.TerraformOutput;
+    readonly nameOutput: cdktf.TerraformOutput;
+    readonly locationOutput: cdktf.TerraformOutput;
+    readonly tagsOutput: cdktf.TerraformOutput;
+    /**
+     * Creates a new Azure Virtual Network Gateway using the AzapiResource framework
+     *
+     * The constructor automatically handles version resolution, schema registration,
+     * validation, and resource creation. It maintains full backward compatibility
+     * with existing Virtual Network Gateway implementations.
+     *
+     * @param scope - The scope in which to define this construct
+     * @param id - The unique identifier for this instance
+     * @param props - Configuration properties for the Virtual Network Gateway
+     */
+    constructor(scope: Construct, id: string, props: VirtualNetworkGatewayProps);
+    /**
+     * Gets the default API version to use when no explicit version is specified
+     * Returns the most recent stable version as the default
+     */
+    protected defaultVersion(): string;
+    /**
+     * Gets the Azure resource type for Virtual Network Gateways
+     */
+    protected resourceType(): string;
+    /**
+     * Gets the API schema for the resolved version
+     * Uses the framework's schema resolution to get the appropriate schema
+     */
+    protected apiSchema(): ApiSchema;
+    /**
+     * Indicates that location is required for Virtual Network Gateways
+     */
+    protected requiresLocation(): boolean;
+    /**
+     * Creates the resource body for the Azure API call
+     * Transforms the input properties into the JSON format expected by Azure REST API
+     */
+    protected createResourceBody(props: any): any;
+    /**
+     * Get the subscription ID from the Virtual Network Gateway ID
+     * Extracts the subscription ID from the Azure resource ID format
+     */
+    get subscriptionId(): string;
+    /**
+     * Get the full resource identifier for use in other Azure resources
+     * Alias for the id property to match original interface
+     */
+    get resourceId(): string;
+    /**
+     * Add a tag to the Virtual Network Gateway
+     * Note: This modifies the construct props but requires a new deployment to take effect
+     */
+    addTag(key: string, value: string): void;
+    /**
+     * Remove a tag from the Virtual Network Gateway
+     * Note: This modifies the construct props but requires a new deployment to take effect
+     */
+    removeTag(key: string): void;
+    /**
+     * Applies ignore changes lifecycle rules if specified in props
+     */
+    private _applyIgnoreChanges;
+}