com.pulumi.azure.network.kotlin.VnpGatewayNatRule.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-azure-kotlin Show documentation
Show all versions of pulumi-azure-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.azure.network.kotlin
import com.pulumi.azure.network.kotlin.outputs.VnpGatewayNatRuleExternalMapping
import com.pulumi.azure.network.kotlin.outputs.VnpGatewayNatRuleInternalMapping
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.Deprecated
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import com.pulumi.azure.network.kotlin.outputs.VnpGatewayNatRuleExternalMapping.Companion.toKotlin as vnpGatewayNatRuleExternalMappingToKotlin
import com.pulumi.azure.network.kotlin.outputs.VnpGatewayNatRuleInternalMapping.Companion.toKotlin as vnpGatewayNatRuleInternalMappingToKotlin
/**
* Builder for [VnpGatewayNatRule].
*/
@PulumiTagMarker
public class VnpGatewayNatRuleResourceBuilder internal constructor() {
public var name: String? = null
public var args: VnpGatewayNatRuleArgs = VnpGatewayNatRuleArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend VnpGatewayNatRuleArgsBuilder.() -> Unit) {
val builder = VnpGatewayNatRuleArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): VnpGatewayNatRule {
val builtJavaResource = com.pulumi.azure.network.VnpGatewayNatRule(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return VnpGatewayNatRule(builtJavaResource)
}
}
/**
* Manages a VPN Gateway NAT Rule.
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as azure from "@pulumi/azure";
* const example = new azure.core.ResourceGroup("example", {
* name: "example-resources",
* location: "West Europe",
* });
* const exampleVirtualWan = new azure.network.VirtualWan("example", {
* name: "example-vwan",
* resourceGroupName: example.name,
* location: example.location,
* });
* const exampleVirtualHub = new azure.network.VirtualHub("example", {
* name: "example-vhub",
* resourceGroupName: example.name,
* location: example.location,
* addressPrefix: "10.0.1.0/24",
* virtualWanId: exampleVirtualWan.id,
* });
* const exampleVpnGateway = new azure.network.VpnGateway("example", {
* name: "example-vpngateway",
* location: example.location,
* resourceGroupName: example.name,
* virtualHubId: exampleVirtualHub.id,
* });
* const exampleVnpGatewayNatRule = new azure.network.VnpGatewayNatRule("example", {
* name: "example-vpngatewaynatrule",
* vpnGatewayId: exampleVpnGateway.id,
* externalMappings: [{
* addressSpace: "192.168.21.0/26",
* }],
* internalMappings: [{
* addressSpace: "10.4.0.0/26",
* }],
* });
* ```
* ```python
* import pulumi
* import pulumi_azure as azure
* example = azure.core.ResourceGroup("example",
* name="example-resources",
* location="West Europe")
* example_virtual_wan = azure.network.VirtualWan("example",
* name="example-vwan",
* resource_group_name=example.name,
* location=example.location)
* example_virtual_hub = azure.network.VirtualHub("example",
* name="example-vhub",
* resource_group_name=example.name,
* location=example.location,
* address_prefix="10.0.1.0/24",
* virtual_wan_id=example_virtual_wan.id)
* example_vpn_gateway = azure.network.VpnGateway("example",
* name="example-vpngateway",
* location=example.location,
* resource_group_name=example.name,
* virtual_hub_id=example_virtual_hub.id)
* example_vnp_gateway_nat_rule = azure.network.VnpGatewayNatRule("example",
* name="example-vpngatewaynatrule",
* vpn_gateway_id=example_vpn_gateway.id,
* external_mappings=[{
* "address_space": "192.168.21.0/26",
* }],
* internal_mappings=[{
* "address_space": "10.4.0.0/26",
* }])
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Azure = Pulumi.Azure;
* return await Deployment.RunAsync(() =>
* {
* var example = new Azure.Core.ResourceGroup("example", new()
* {
* Name = "example-resources",
* Location = "West Europe",
* });
* var exampleVirtualWan = new Azure.Network.VirtualWan("example", new()
* {
* Name = "example-vwan",
* ResourceGroupName = example.Name,
* Location = example.Location,
* });
* var exampleVirtualHub = new Azure.Network.VirtualHub("example", new()
* {
* Name = "example-vhub",
* ResourceGroupName = example.Name,
* Location = example.Location,
* AddressPrefix = "10.0.1.0/24",
* VirtualWanId = exampleVirtualWan.Id,
* });
* var exampleVpnGateway = new Azure.Network.VpnGateway("example", new()
* {
* Name = "example-vpngateway",
* Location = example.Location,
* ResourceGroupName = example.Name,
* VirtualHubId = exampleVirtualHub.Id,
* });
* var exampleVnpGatewayNatRule = new Azure.Network.VnpGatewayNatRule("example", new()
* {
* Name = "example-vpngatewaynatrule",
* VpnGatewayId = exampleVpnGateway.Id,
* ExternalMappings = new[]
* {
* new Azure.Network.Inputs.VnpGatewayNatRuleExternalMappingArgs
* {
* AddressSpace = "192.168.21.0/26",
* },
* },
* InternalMappings = new[]
* {
* new Azure.Network.Inputs.VnpGatewayNatRuleInternalMappingArgs
* {
* AddressSpace = "10.4.0.0/26",
* },
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
* "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/network"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
* Name: pulumi.String("example-resources"),
* Location: pulumi.String("West Europe"),
* })
* if err != nil {
* return err
* }
* exampleVirtualWan, err := network.NewVirtualWan(ctx, "example", &network.VirtualWanArgs{
* Name: pulumi.String("example-vwan"),
* ResourceGroupName: example.Name,
* Location: example.Location,
* })
* if err != nil {
* return err
* }
* exampleVirtualHub, err := network.NewVirtualHub(ctx, "example", &network.VirtualHubArgs{
* Name: pulumi.String("example-vhub"),
* ResourceGroupName: example.Name,
* Location: example.Location,
* AddressPrefix: pulumi.String("10.0.1.0/24"),
* VirtualWanId: exampleVirtualWan.ID(),
* })
* if err != nil {
* return err
* }
* exampleVpnGateway, err := network.NewVpnGateway(ctx, "example", &network.VpnGatewayArgs{
* Name: pulumi.String("example-vpngateway"),
* Location: example.Location,
* ResourceGroupName: example.Name,
* VirtualHubId: exampleVirtualHub.ID(),
* })
* if err != nil {
* return err
* }
* _, err = network.NewVnpGatewayNatRule(ctx, "example", &network.VnpGatewayNatRuleArgs{
* Name: pulumi.String("example-vpngatewaynatrule"),
* VpnGatewayId: exampleVpnGateway.ID(),
* ExternalMappings: network.VnpGatewayNatRuleExternalMappingArray{
* &network.VnpGatewayNatRuleExternalMappingArgs{
* AddressSpace: pulumi.String("192.168.21.0/26"),
* },
* },
* InternalMappings: network.VnpGatewayNatRuleInternalMappingArray{
* &network.VnpGatewayNatRuleInternalMappingArgs{
* AddressSpace: pulumi.String("10.4.0.0/26"),
* },
* },
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* package generated_program;
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.azure.core.ResourceGroup;
* import com.pulumi.azure.core.ResourceGroupArgs;
* import com.pulumi.azure.network.VirtualWan;
* import com.pulumi.azure.network.VirtualWanArgs;
* import com.pulumi.azure.network.VirtualHub;
* import com.pulumi.azure.network.VirtualHubArgs;
* import com.pulumi.azure.network.VpnGateway;
* import com.pulumi.azure.network.VpnGatewayArgs;
* import com.pulumi.azure.network.VnpGatewayNatRule;
* import com.pulumi.azure.network.VnpGatewayNatRuleArgs;
* import com.pulumi.azure.network.inputs.VnpGatewayNatRuleExternalMappingArgs;
* import com.pulumi.azure.network.inputs.VnpGatewayNatRuleInternalMappingArgs;
* import java.util.List;
* import java.util.ArrayList;
* import java.util.Map;
* import java.io.File;
* import java.nio.file.Files;
* import java.nio.file.Paths;
* public class App {
* public static void main(String[] args) {
* Pulumi.run(App::stack);
* }
* public static void stack(Context ctx) {
* var example = new ResourceGroup("example", ResourceGroupArgs.builder()
* .name("example-resources")
* .location("West Europe")
* .build());
* var exampleVirtualWan = new VirtualWan("exampleVirtualWan", VirtualWanArgs.builder()
* .name("example-vwan")
* .resourceGroupName(example.name())
* .location(example.location())
* .build());
* var exampleVirtualHub = new VirtualHub("exampleVirtualHub", VirtualHubArgs.builder()
* .name("example-vhub")
* .resourceGroupName(example.name())
* .location(example.location())
* .addressPrefix("10.0.1.0/24")
* .virtualWanId(exampleVirtualWan.id())
* .build());
* var exampleVpnGateway = new VpnGateway("exampleVpnGateway", VpnGatewayArgs.builder()
* .name("example-vpngateway")
* .location(example.location())
* .resourceGroupName(example.name())
* .virtualHubId(exampleVirtualHub.id())
* .build());
* var exampleVnpGatewayNatRule = new VnpGatewayNatRule("exampleVnpGatewayNatRule", VnpGatewayNatRuleArgs.builder()
* .name("example-vpngatewaynatrule")
* .vpnGatewayId(exampleVpnGateway.id())
* .externalMappings(VnpGatewayNatRuleExternalMappingArgs.builder()
* .addressSpace("192.168.21.0/26")
* .build())
* .internalMappings(VnpGatewayNatRuleInternalMappingArgs.builder()
* .addressSpace("10.4.0.0/26")
* .build())
* .build());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: azure:core:ResourceGroup
* properties:
* name: example-resources
* location: West Europe
* exampleVirtualWan:
* type: azure:network:VirtualWan
* name: example
* properties:
* name: example-vwan
* resourceGroupName: ${example.name}
* location: ${example.location}
* exampleVirtualHub:
* type: azure:network:VirtualHub
* name: example
* properties:
* name: example-vhub
* resourceGroupName: ${example.name}
* location: ${example.location}
* addressPrefix: 10.0.1.0/24
* virtualWanId: ${exampleVirtualWan.id}
* exampleVpnGateway:
* type: azure:network:VpnGateway
* name: example
* properties:
* name: example-vpngateway
* location: ${example.location}
* resourceGroupName: ${example.name}
* virtualHubId: ${exampleVirtualHub.id}
* exampleVnpGatewayNatRule:
* type: azure:network:VnpGatewayNatRule
* name: example
* properties:
* name: example-vpngatewaynatrule
* vpnGatewayId: ${exampleVpnGateway.id}
* externalMappings:
* - addressSpace: 192.168.21.0/26
* internalMappings:
* - addressSpace: 10.4.0.0/26
* ```
*
* ## Import
* VPN Gateway NAT Rules can be imported using the `resource id`, e.g.
* ```sh
* $ pulumi import azure:network/vnpGatewayNatRule:VnpGatewayNatRule example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resGroup1/providers/Microsoft.Network/vpnGateways/vpnGateway1/natRules/natRule1
* ```
*/
public class VnpGatewayNatRule internal constructor(
override val javaResource: com.pulumi.azure.network.VnpGatewayNatRule,
) : KotlinCustomResource(javaResource, VnpGatewayNatRuleMapper) {
@Deprecated(
message = """
`external_address_space_mappings` will be removed in favour of the property `external_mapping` in
version 4.0 of the AzureRM Provider.
""",
)
public val externalAddressSpaceMappings: Output>
get() = javaResource.externalAddressSpaceMappings().applyValue({ args0 ->
args0.map({ args0 ->
args0
})
})
/**
* One of more `external_mapping` blocks as defined below.
*/
public val externalMappings: Output>
get() = javaResource.externalMappings().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> vnpGatewayNatRuleExternalMappingToKotlin(args0) })
})
})
@Deprecated(
message = """
`internal_address_space_mappings` will be removed in favour of the property `internal_mapping` in
version 4.0 of the AzureRM Provider.
""",
)
public val internalAddressSpaceMappings: Output>
get() = javaResource.internalAddressSpaceMappings().applyValue({ args0 ->
args0.map({ args0 ->
args0
})
})
/**
* One of more `internal_mapping` blocks as defined below.
*/
public val internalMappings: Output>
get() = javaResource.internalMappings().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> vnpGatewayNatRuleInternalMappingToKotlin(args0) })
})
})
/**
* The ID of the IP Configuration this VPN Gateway NAT Rule applies to. Possible values are `Instance0` and `Instance1`.
*/
public val ipConfigurationId: Output?
get() = javaResource.ipConfigurationId().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The source NAT direction of the VPN NAT. Possible values are `EgressSnat` and `IngressSnat`. Defaults to `EgressSnat`. Changing this forces a new resource to be created.
*/
public val mode: Output?
get() = javaResource.mode().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* The name which should be used for this VPN Gateway NAT Rule. Changing this forces a new resource to be created.
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
@Deprecated(
message = """
The property `resource_group_name` has been superseded by `vpn_gateway_id` and will be removed in
v4.0 of the AzureRM provider
""",
)
public val resourceGroupName: Output
get() = javaResource.resourceGroupName().applyValue({ args0 -> args0 })
/**
* The type of the VPN Gateway NAT Rule. Possible values are `Dynamic` and `Static`. Defaults to `Static`. Changing this forces a new resource to be created.
*/
public val type: Output?
get() = javaResource.type().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* The ID of the VPN Gateway that this VPN Gateway NAT Rule belongs to. Changing this forces a new resource to be created.
*/
public val vpnGatewayId: Output
get() = javaResource.vpnGatewayId().applyValue({ args0 -> args0 })
}
public object VnpGatewayNatRuleMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.azure.network.VnpGatewayNatRule::class == javaResource::class
override fun map(javaResource: Resource): VnpGatewayNatRule = VnpGatewayNatRule(
javaResource as
com.pulumi.azure.network.VnpGatewayNatRule,
)
}
/**
* @see [VnpGatewayNatRule].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [VnpGatewayNatRule].
*/
public suspend fun vnpGatewayNatRule(
name: String,
block: suspend VnpGatewayNatRuleResourceBuilder.() -> Unit,
): VnpGatewayNatRule {
val builder = VnpGatewayNatRuleResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [VnpGatewayNatRule].
* @param name The _unique_ name of the resulting resource.
*/
public fun vnpGatewayNatRule(name: String): VnpGatewayNatRule {
val builder = VnpGatewayNatRuleResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy