com.pulumi.azurenative.network.VpnGateway Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-native Show documentation
Show all versions of azure-native Show documentation
A native Pulumi package for creating and managing Azure resources.
// *** 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.azurenative.network;
import com.pulumi.azurenative.Utilities;
import com.pulumi.azurenative.network.VpnGatewayArgs;
import com.pulumi.azurenative.network.outputs.BgpSettingsResponse;
import com.pulumi.azurenative.network.outputs.SubResourceResponse;
import com.pulumi.azurenative.network.outputs.VpnConnectionResponse;
import com.pulumi.azurenative.network.outputs.VpnGatewayIpConfigurationResponse;
import com.pulumi.azurenative.network.outputs.VpnGatewayNatRuleResponse;
import com.pulumi.core.Alias;
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.List;
import java.util.Map;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* VpnGateway Resource.
* Azure REST API version: 2023-02-01. Prior API version in Azure Native 1.x: 2020-11-01.
*
* Other available API versions: 2018-07-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01.
*
* ## Example Usage
* ### VpnGatewayPut
*
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.azurenative.network.VpnGateway;
* import com.pulumi.azurenative.network.VpnGatewayArgs;
* import com.pulumi.azurenative.network.inputs.BgpSettingsArgs;
* import com.pulumi.azurenative.network.inputs.VpnConnectionArgs;
* import com.pulumi.azurenative.network.inputs.SubResourceArgs;
* import com.pulumi.azurenative.network.inputs.VpnGatewayNatRuleArgs;
* 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 vpnGateway = new VpnGateway("vpnGateway", VpnGatewayArgs.builder()
* .bgpSettings(BgpSettingsArgs.builder()
* .asn(65515)
* .bgpPeeringAddresses(
* IPConfigurationBgpPeeringAddressArgs.builder()
* .customBgpIpAddresses("169.254.21.5")
* .ipconfigurationId("Instance0")
* .build(),
* IPConfigurationBgpPeeringAddressArgs.builder()
* .customBgpIpAddresses("169.254.21.10")
* .ipconfigurationId("Instance1")
* .build())
* .peerWeight(0)
* .build())
* .connections(VpnConnectionArgs.builder()
* .name("vpnConnection1")
* .remoteVpnSite(SubResourceArgs.builder()
* .id("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1")
* .build())
* .vpnLinkConnections(VpnSiteLinkConnectionArgs.builder()
* .connectionBandwidth(200)
* .egressNatRules(SubResourceArgs.builder()
* .id("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03")
* .build())
* .name("Connection-Link1")
* .sharedKey("key")
* .vpnConnectionProtocolType("IKEv2")
* .vpnSiteLink(SubResourceArgs.builder()
* .id("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1")
* .build())
* .build())
* .build())
* .enableBgpRouteTranslationForNat(false)
* .gatewayName("gateway1")
* .isRoutingPreferenceInternet(false)
* .location("westcentralus")
* .natRules(VpnGatewayNatRuleArgs.builder()
* .externalMappings(VpnNatRuleMappingArgs.builder()
* .addressSpace("192.168.0.0/26")
* .build())
* .internalMappings(VpnNatRuleMappingArgs.builder()
* .addressSpace("0.0.0.0/26")
* .build())
* .ipConfigurationId("")
* .mode("EgressSnat")
* .name("nat03")
* .type("Static")
* .build())
* .resourceGroupName("rg1")
* .tags(Map.of("key1", "value1"))
* .virtualHub(SubResourceArgs.builder()
* .id("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1")
* .build())
* .build());
*
* }
* }
*
* }
*
*
* ## Import
*
* An existing resource can be imported using its type token, name, and identifier, e.g.
*
* ```sh
* $ pulumi import azure-native:network:VpnGateway gateway1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}
* ```
*
*/
@ResourceType(type="azure-native:network:VpnGateway")
public class VpnGateway extends com.pulumi.resources.CustomResource {
/**
* Local network gateway's BGP speaker settings.
*
*/
@Export(name="bgpSettings", refs={BgpSettingsResponse.class}, tree="[0]")
private Output bgpSettings;
/**
* @return Local network gateway's BGP speaker settings.
*
*/
public Output> bgpSettings() {
return Codegen.optional(this.bgpSettings);
}
/**
* List of all vpn connections to the gateway.
*
*/
@Export(name="connections", refs={List.class,VpnConnectionResponse.class}, tree="[0,1]")
private Output> connections;
/**
* @return List of all vpn connections to the gateway.
*
*/
public Output>> connections() {
return Codegen.optional(this.connections);
}
/**
* Enable BGP routes translation for NAT on this VpnGateway.
*
*/
@Export(name="enableBgpRouteTranslationForNat", refs={Boolean.class}, tree="[0]")
private Output enableBgpRouteTranslationForNat;
/**
* @return Enable BGP routes translation for NAT on this VpnGateway.
*
*/
public Output> enableBgpRouteTranslationForNat() {
return Codegen.optional(this.enableBgpRouteTranslationForNat);
}
/**
* A unique read-only string that changes whenever the resource is updated.
*
*/
@Export(name="etag", refs={String.class}, tree="[0]")
private Output etag;
/**
* @return A unique read-only string that changes whenever the resource is updated.
*
*/
public Output etag() {
return this.etag;
}
/**
* List of all IPs configured on the gateway.
*
*/
@Export(name="ipConfigurations", refs={List.class,VpnGatewayIpConfigurationResponse.class}, tree="[0,1]")
private Output> ipConfigurations;
/**
* @return List of all IPs configured on the gateway.
*
*/
public Output> ipConfigurations() {
return this.ipConfigurations;
}
/**
* Enable Routing Preference property for the Public IP Interface of the VpnGateway.
*
*/
@Export(name="isRoutingPreferenceInternet", refs={Boolean.class}, tree="[0]")
private Output isRoutingPreferenceInternet;
/**
* @return Enable Routing Preference property for the Public IP Interface of the VpnGateway.
*
*/
public Output> isRoutingPreferenceInternet() {
return Codegen.optional(this.isRoutingPreferenceInternet);
}
/**
* Resource location.
*
*/
@Export(name="location", refs={String.class}, tree="[0]")
private Output location;
/**
* @return Resource location.
*
*/
public Output location() {
return this.location;
}
/**
* Resource name.
*
*/
@Export(name="name", refs={String.class}, tree="[0]")
private Output name;
/**
* @return Resource name.
*
*/
public Output name() {
return this.name;
}
/**
* List of all the nat Rules associated with the gateway.
*
*/
@Export(name="natRules", refs={List.class,VpnGatewayNatRuleResponse.class}, tree="[0,1]")
private Output> natRules;
/**
* @return List of all the nat Rules associated with the gateway.
*
*/
public Output>> natRules() {
return Codegen.optional(this.natRules);
}
/**
* The provisioning state of the VPN gateway resource.
*
*/
@Export(name="provisioningState", refs={String.class}, tree="[0]")
private Output provisioningState;
/**
* @return The provisioning state of the VPN gateway resource.
*
*/
public Output provisioningState() {
return this.provisioningState;
}
/**
* Resource tags.
*
*/
@Export(name="tags", refs={Map.class,String.class}, tree="[0,1,1]")
private Output> tags;
/**
* @return Resource tags.
*
*/
public Output>> tags() {
return Codegen.optional(this.tags);
}
/**
* Resource type.
*
*/
@Export(name="type", refs={String.class}, tree="[0]")
private Output type;
/**
* @return Resource type.
*
*/
public Output type() {
return this.type;
}
/**
* The VirtualHub to which the gateway belongs.
*
*/
@Export(name="virtualHub", refs={SubResourceResponse.class}, tree="[0]")
private Output virtualHub;
/**
* @return The VirtualHub to which the gateway belongs.
*
*/
public Output> virtualHub() {
return Codegen.optional(this.virtualHub);
}
/**
* The scale unit for this vpn gateway.
*
*/
@Export(name="vpnGatewayScaleUnit", refs={Integer.class}, tree="[0]")
private Output vpnGatewayScaleUnit;
/**
* @return The scale unit for this vpn gateway.
*
*/
public Output> vpnGatewayScaleUnit() {
return Codegen.optional(this.vpnGatewayScaleUnit);
}
/**
*
* @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-native:network:VpnGateway", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private VpnGateway(java.lang.String name, Output id, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure-native:network:VpnGateway", name, null, 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())
.aliases(List.of(
Output.of(Alias.builder().type("azure-native:network/v20180401:VpnGateway").build()),
Output.of(Alias.builder().type("azure-native:network/v20180601:VpnGateway").build()),
Output.of(Alias.builder().type("azure-native:network/v20180701:VpnGateway").build()),
Output.of(Alias.builder().type("azure-native:network/v20180801:VpnGateway").build()),
Output.of(Alias.builder().type("azure-native:network/v20181001:VpnGateway").build()),
Output.of(Alias.builder().type("azure-native:network/v20181101:VpnGateway").build()),
Output.of(Alias.builder().type("azure-native:network/v20181201:VpnGateway").build()),
Output.of(Alias.builder().type("azure-native:network/v20190201:VpnGateway").build()),
Output.of(Alias.builder().type("azure-native:network/v20190401:VpnGateway").build()),
Output.of(Alias.builder().type("azure-native:network/v20190601:VpnGateway").build()),
Output.of(Alias.builder().type("azure-native:network/v20190701:VpnGateway").build()),
Output.of(Alias.builder().type("azure-native:network/v20190801:VpnGateway").build()),
Output.of(Alias.builder().type("azure-native:network/v20190901:VpnGateway").build()),
Output.of(Alias.builder().type("azure-native:network/v20191101:VpnGateway").build()),
Output.of(Alias.builder().type("azure-native:network/v20191201:VpnGateway").build()),
Output.of(Alias.builder().type("azure-native:network/v20200301:VpnGateway").build()),
Output.of(Alias.builder().type("azure-native:network/v20200401:VpnGateway").build()),
Output.of(Alias.builder().type("azure-native:network/v20200501:VpnGateway").build()),
Output.of(Alias.builder().type("azure-native:network/v20200601:VpnGateway").build()),
Output.of(Alias.builder().type("azure-native:network/v20200701:VpnGateway").build()),
Output.of(Alias.builder().type("azure-native:network/v20200801:VpnGateway").build()),
Output.of(Alias.builder().type("azure-native:network/v20201101:VpnGateway").build()),
Output.of(Alias.builder().type("azure-native:network/v20210201:VpnGateway").build()),
Output.of(Alias.builder().type("azure-native:network/v20210301:VpnGateway").build()),
Output.of(Alias.builder().type("azure-native:network/v20210501:VpnGateway").build()),
Output.of(Alias.builder().type("azure-native:network/v20210801:VpnGateway").build()),
Output.of(Alias.builder().type("azure-native:network/v20220101:VpnGateway").build()),
Output.of(Alias.builder().type("azure-native:network/v20220501:VpnGateway").build()),
Output.of(Alias.builder().type("azure-native:network/v20220701:VpnGateway").build()),
Output.of(Alias.builder().type("azure-native:network/v20220901:VpnGateway").build()),
Output.of(Alias.builder().type("azure-native:network/v20221101:VpnGateway").build()),
Output.of(Alias.builder().type("azure-native:network/v20230201:VpnGateway").build()),
Output.of(Alias.builder().type("azure-native:network/v20230401:VpnGateway").build()),
Output.of(Alias.builder().type("azure-native:network/v20230501:VpnGateway").build()),
Output.of(Alias.builder().type("azure-native:network/v20230601:VpnGateway").build()),
Output.of(Alias.builder().type("azure-native:network/v20230901:VpnGateway").build()),
Output.of(Alias.builder().type("azure-native:network/v20231101:VpnGateway").build()),
Output.of(Alias.builder().type("azure-native:network/v20240101:VpnGateway").build()),
Output.of(Alias.builder().type("azure-native:network/v20240301:VpnGateway").build())
))
.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 options Optional settings to control the behavior of the CustomResource.
*/
public static VpnGateway get(java.lang.String name, Output id, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new VpnGateway(name, id, options);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy