com.pulumi.azure.network.VpnGateway Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure Show documentation
Show all versions of azure Show documentation
A Pulumi package for creating and managing Microsoft Azure cloud resources, based on the Terraform azurerm provider. We recommend using the [Azure Native provider](https://github.com/pulumi/pulumi-azure-native) to provision Azure infrastructure. Azure Native provides complete coverage of Azure resources and same-day access to new resources and resource updates.
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.azure.network;
import com.pulumi.azure.Utilities;
import com.pulumi.azure.network.VpnGatewayArgs;
import com.pulumi.azure.network.inputs.VpnGatewayState;
import com.pulumi.azure.network.outputs.VpnGatewayBgpSettings;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import java.lang.Boolean;
import java.lang.Integer;
import java.lang.String;
import java.util.Map;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* Manages a VPN Gateway within a Virtual Hub, which enables Site-to-Site communication.
*
* ## Example Usage
*
* <!--Start PulumiCodeChooser -->
*
* {@code
* 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.VirtualNetwork;
* import com.pulumi.azure.network.VirtualNetworkArgs;
* 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 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 exampleVirtualNetwork = new VirtualNetwork("exampleVirtualNetwork", VirtualNetworkArgs.builder()
* .name("example-network")
* .location(example.location())
* .resourceGroupName(example.name())
* .addressSpaces("10.0.0.0/16")
* .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-hub")
* .resourceGroupName(example.name())
* .location(example.location())
* .virtualWanId(exampleVirtualWan.id())
* .addressPrefix("10.0.1.0/24")
* .build());
*
* var exampleVpnGateway = new VpnGateway("exampleVpnGateway", VpnGatewayArgs.builder()
* .name("example-vpng")
* .location(example.location())
* .resourceGroupName(example.name())
* .virtualHubId(exampleVirtualHub.id())
* .build());
*
* }
* }
* }
*
* <!--End PulumiCodeChooser -->
*
* ## Import
*
* VPN Gateways can be imported using the `resource id`, e.g.
*
* ```sh
* $ pulumi import azure:network/vpnGateway:VpnGateway gateway1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Network/vpnGateways/gateway1
* ```
*
*/
@ResourceType(type="azure:network/vpnGateway:VpnGateway")
public class VpnGateway extends com.pulumi.resources.CustomResource {
/**
* Is BGP route translation for NAT on this VPN Gateway enabled? Defaults to `false`.
*
*/
@Export(name="bgpRouteTranslationForNatEnabled", refs={Boolean.class}, tree="[0]")
private Output bgpRouteTranslationForNatEnabled;
/**
* @return Is BGP route translation for NAT on this VPN Gateway enabled? Defaults to `false`.
*
*/
public Output> bgpRouteTranslationForNatEnabled() {
return Codegen.optional(this.bgpRouteTranslationForNatEnabled);
}
/**
* A `bgp_settings` block as defined below.
*
*/
@Export(name="bgpSettings", refs={VpnGatewayBgpSettings.class}, tree="[0]")
private Output bgpSettings;
/**
* @return A `bgp_settings` block as defined below.
*
*/
public Output bgpSettings() {
return this.bgpSettings;
}
/**
* The Azure location where this VPN Gateway should be created. Changing this forces a new resource to be created.
*
*/
@Export(name="location", refs={String.class}, tree="[0]")
private Output location;
/**
* @return The Azure location where this VPN Gateway should be created. Changing this forces a new resource to be created.
*
*/
public Output location() {
return this.location;
}
/**
* The Name which should be used for this VPN Gateway. Changing this forces a new resource to be created.
*
*/
@Export(name="name", refs={String.class}, tree="[0]")
private Output name;
/**
* @return The Name which should be used for this VPN Gateway. Changing this forces a new resource to be created.
*
*/
public Output name() {
return this.name;
}
/**
* The Name of the Resource Group in which this VPN Gateway should be created. Changing this forces a new resource to be created.
*
*/
@Export(name="resourceGroupName", refs={String.class}, tree="[0]")
private Output resourceGroupName;
/**
* @return The Name of the Resource Group in which this VPN Gateway should be created. Changing this forces a new resource to be created.
*
*/
public Output resourceGroupName() {
return this.resourceGroupName;
}
/**
* Azure routing preference lets you to choose how your traffic routes between Azure and the internet. You can choose to route traffic either via the Microsoft network (default value, `Microsoft Network`), or via the ISP network (public internet, set to `Internet`). More context of the configuration can be found in the [Microsoft Docs](https://docs.microsoft.com/azure/virtual-wan/virtual-wan-site-to-site-portal#gateway) to create a VPN Gateway. Defaults to `Microsoft Network`. Changing this forces a new resource to be created.
*
*/
@Export(name="routingPreference", refs={String.class}, tree="[0]")
private Output routingPreference;
/**
* @return Azure routing preference lets you to choose how your traffic routes between Azure and the internet. You can choose to route traffic either via the Microsoft network (default value, `Microsoft Network`), or via the ISP network (public internet, set to `Internet`). More context of the configuration can be found in the [Microsoft Docs](https://docs.microsoft.com/azure/virtual-wan/virtual-wan-site-to-site-portal#gateway) to create a VPN Gateway. Defaults to `Microsoft Network`. Changing this forces a new resource to be created.
*
*/
public Output> routingPreference() {
return Codegen.optional(this.routingPreference);
}
/**
* The Scale Unit for this VPN Gateway. Defaults to `1`.
*
*/
@Export(name="scaleUnit", refs={Integer.class}, tree="[0]")
private Output scaleUnit;
/**
* @return The Scale Unit for this VPN Gateway. Defaults to `1`.
*
*/
public Output> scaleUnit() {
return Codegen.optional(this.scaleUnit);
}
/**
* A mapping of tags to assign to the VPN Gateway.
*
*/
@Export(name="tags", refs={Map.class,String.class}, tree="[0,1,1]")
private Output> tags;
/**
* @return A mapping of tags to assign to the VPN Gateway.
*
*/
public Output>> tags() {
return Codegen.optional(this.tags);
}
/**
* The ID of the Virtual Hub within which this VPN Gateway should be created. Changing this forces a new resource to be created.
*
*/
@Export(name="virtualHubId", refs={String.class}, tree="[0]")
private Output virtualHubId;
/**
* @return The ID of the Virtual Hub within which this VPN Gateway should be created. Changing this forces a new resource to be created.
*
*/
public Output virtualHubId() {
return this.virtualHubId;
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public VpnGateway(java.lang.String name) {
this(name, VpnGatewayArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public VpnGateway(java.lang.String name, VpnGatewayArgs args) {
this(name, args, null);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
* @param options A bag of options that control this resource's behavior.
*/
public VpnGateway(java.lang.String name, VpnGatewayArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure:network/vpnGateway:VpnGateway", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private VpnGateway(java.lang.String name, Output id, @Nullable VpnGatewayState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure:network/vpnGateway:VpnGateway", name, state, makeResourceOptions(options, id), false);
}
private static VpnGatewayArgs makeArgs(VpnGatewayArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? VpnGatewayArgs.Empty : args;
}
private static com.pulumi.resources.CustomResourceOptions makeResourceOptions(@Nullable com.pulumi.resources.CustomResourceOptions options, @Nullable Output id) {
var defaultOptions = com.pulumi.resources.CustomResourceOptions.builder()
.version(Utilities.getVersion())
.build();
return com.pulumi.resources.CustomResourceOptions.merge(defaultOptions, options, id);
}
/**
* Get an existing Host resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state
* @param options Optional settings to control the behavior of the CustomResource.
*/
public static VpnGateway get(java.lang.String name, Output id, @Nullable VpnGatewayState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new VpnGateway(name, id, state, options);
}
}