Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. IsVpnGateway
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.IsVpnGateway

Explore with Pulumi AI

ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

Create, update, or delete a VPN gateway. For more information, about VPN gateway, see adding connections to a VPN gateway.

Note: VPC infrastructure services are a regional specific based endpoint, by default targets to us-south. Please make sure to target right region in the provider block as shown in the provider.tf file, if VPC service is created in region other than us-south.

provider.tf

import * as pulumi from "@pulumi/pulumi";
Copy
import pulumi
Copy
package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;

return await Deployment.RunAsync(() => 
{
});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
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) {
    }
}
Copy
{}
Copy

Example Usage

The following example creates a VPN gateway:

import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const exampleIsVpc = new ibm.IsVpc("exampleIsVpc", {});
const exampleIsSubnet = new ibm.IsSubnet("exampleIsSubnet", {
    vpc: exampleIsVpc.isVpcId,
    zone: "us-south-1",
    ipv4CidrBlock: "10.240.0.0/24",
});
const exampleIsVpnGateway = new ibm.IsVpnGateway("exampleIsVpnGateway", {
    subnet: exampleIsSubnet.isSubnetId,
    mode: "route",
});
Copy
import pulumi
import pulumi_ibm as ibm

example_is_vpc = ibm.IsVpc("exampleIsVpc")
example_is_subnet = ibm.IsSubnet("exampleIsSubnet",
    vpc=example_is_vpc.is_vpc_id,
    zone="us-south-1",
    ipv4_cidr_block="10.240.0.0/24")
example_is_vpn_gateway = ibm.IsVpnGateway("exampleIsVpnGateway",
    subnet=example_is_subnet.is_subnet_id,
    mode="route")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleIsVpc, err := ibm.NewIsVpc(ctx, "exampleIsVpc", nil)
		if err != nil {
			return err
		}
		exampleIsSubnet, err := ibm.NewIsSubnet(ctx, "exampleIsSubnet", &ibm.IsSubnetArgs{
			Vpc:           exampleIsVpc.IsVpcId,
			Zone:          pulumi.String("us-south-1"),
			Ipv4CidrBlock: pulumi.String("10.240.0.0/24"),
		})
		if err != nil {
			return err
		}
		_, err = ibm.NewIsVpnGateway(ctx, "exampleIsVpnGateway", &ibm.IsVpnGatewayArgs{
			Subnet: exampleIsSubnet.IsSubnetId,
			Mode:   pulumi.String("route"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var exampleIsVpc = new Ibm.IsVpc("exampleIsVpc");

    var exampleIsSubnet = new Ibm.IsSubnet("exampleIsSubnet", new()
    {
        Vpc = exampleIsVpc.IsVpcId,
        Zone = "us-south-1",
        Ipv4CidrBlock = "10.240.0.0/24",
    });

    var exampleIsVpnGateway = new Ibm.IsVpnGateway("exampleIsVpnGateway", new()
    {
        Subnet = exampleIsSubnet.IsSubnetId,
        Mode = "route",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IsVpc;
import com.pulumi.ibm.IsSubnet;
import com.pulumi.ibm.IsSubnetArgs;
import com.pulumi.ibm.IsVpnGateway;
import com.pulumi.ibm.IsVpnGatewayArgs;
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 exampleIsVpc = new IsVpc("exampleIsVpc");

        var exampleIsSubnet = new IsSubnet("exampleIsSubnet", IsSubnetArgs.builder()
            .vpc(exampleIsVpc.isVpcId())
            .zone("us-south-1")
            .ipv4CidrBlock("10.240.0.0/24")
            .build());

        var exampleIsVpnGateway = new IsVpnGateway("exampleIsVpnGateway", IsVpnGatewayArgs.builder()
            .subnet(exampleIsSubnet.isSubnetId())
            .mode("route")
            .build());

    }
}
Copy
resources:
  exampleIsVpc:
    type: ibm:IsVpc
  exampleIsSubnet:
    type: ibm:IsSubnet
    properties:
      vpc: ${exampleIsVpc.isVpcId}
      zone: us-south-1
      ipv4CidrBlock: 10.240.0.0/24
  exampleIsVpnGateway:
    type: ibm:IsVpnGateway
    properties:
      subnet: ${exampleIsSubnet.isSubnetId}
      mode: route
Copy

Create IsVpnGateway Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new IsVpnGateway(name: string, args: IsVpnGatewayArgs, opts?: CustomResourceOptions);
@overload
def IsVpnGateway(resource_name: str,
                 args: IsVpnGatewayArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def IsVpnGateway(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 subnet: Optional[str] = None,
                 access_tags: Optional[Sequence[str]] = None,
                 is_vpn_gateway_id: Optional[str] = None,
                 mode: Optional[str] = None,
                 name: Optional[str] = None,
                 resource_group: Optional[str] = None,
                 tags: Optional[Sequence[str]] = None,
                 timeouts: Optional[IsVpnGatewayTimeoutsArgs] = None)
func NewIsVpnGateway(ctx *Context, name string, args IsVpnGatewayArgs, opts ...ResourceOption) (*IsVpnGateway, error)
public IsVpnGateway(string name, IsVpnGatewayArgs args, CustomResourceOptions? opts = null)
public IsVpnGateway(String name, IsVpnGatewayArgs args)
public IsVpnGateway(String name, IsVpnGatewayArgs args, CustomResourceOptions options)

type: ibm:IsVpnGateway
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. IsVpnGatewayArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. IsVpnGatewayArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. IsVpnGatewayArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. IsVpnGatewayArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. IsVpnGatewayArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var isVpnGatewayResource = new Ibm.IsVpnGateway("isVpnGatewayResource", new()
{
    Subnet = "string",
    AccessTags = new[]
    {
        "string",
    },
    IsVpnGatewayId = "string",
    Mode = "string",
    Name = "string",
    ResourceGroup = "string",
    Tags = new[]
    {
        "string",
    },
    Timeouts = new Ibm.Inputs.IsVpnGatewayTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
    },
});
Copy
example, err := ibm.NewIsVpnGateway(ctx, "isVpnGatewayResource", &ibm.IsVpnGatewayArgs{
Subnet: pulumi.String("string"),
AccessTags: pulumi.StringArray{
pulumi.String("string"),
},
IsVpnGatewayId: pulumi.String("string"),
Mode: pulumi.String("string"),
Name: pulumi.String("string"),
ResourceGroup: pulumi.String("string"),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
Timeouts: &.IsVpnGatewayTimeoutsArgs{
Create: pulumi.String("string"),
Delete: pulumi.String("string"),
},
})
Copy
var isVpnGatewayResource = new IsVpnGateway("isVpnGatewayResource", IsVpnGatewayArgs.builder()
    .subnet("string")
    .accessTags("string")
    .isVpnGatewayId("string")
    .mode("string")
    .name("string")
    .resourceGroup("string")
    .tags("string")
    .timeouts(IsVpnGatewayTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .build())
    .build());
Copy
is_vpn_gateway_resource = ibm.IsVpnGateway("isVpnGatewayResource",
    subnet="string",
    access_tags=["string"],
    is_vpn_gateway_id="string",
    mode="string",
    name="string",
    resource_group="string",
    tags=["string"],
    timeouts={
        "create": "string",
        "delete": "string",
    })
Copy
const isVpnGatewayResource = new ibm.IsVpnGateway("isVpnGatewayResource", {
    subnet: "string",
    accessTags: ["string"],
    isVpnGatewayId: "string",
    mode: "string",
    name: "string",
    resourceGroup: "string",
    tags: ["string"],
    timeouts: {
        create: "string",
        "delete": "string",
    },
});
Copy
type: ibm:IsVpnGateway
properties:
    accessTags:
        - string
    isVpnGatewayId: string
    mode: string
    name: string
    resourceGroup: string
    subnet: string
    tags:
        - string
    timeouts:
        create: string
        delete: string
Copy

IsVpnGateway Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The IsVpnGateway resource accepts the following input properties:

Subnet This property is required. string
The unique identifier for this subnet.
AccessTags List<string>
List of access management tags
IsVpnGatewayId string
(String) - The unique identifier for this VPC.
Mode string
Mode in VPN gateway. Supported values are route or policy. The default value is route.
Name string
The name of the VPN gateway.
ResourceGroup string
The resource group (id), where the VPN gateway to be created.
Tags List<string>
A list of tags that you want to add to your VPN gateway. Tags can help you find your VPN gateway more easily later.
Timeouts IsVpnGatewayTimeouts
Subnet This property is required. string
The unique identifier for this subnet.
AccessTags []string
List of access management tags
IsVpnGatewayId string
(String) - The unique identifier for this VPC.
Mode string
Mode in VPN gateway. Supported values are route or policy. The default value is route.
Name string
The name of the VPN gateway.
ResourceGroup string
The resource group (id), where the VPN gateway to be created.
Tags []string
A list of tags that you want to add to your VPN gateway. Tags can help you find your VPN gateway more easily later.
Timeouts IsVpnGatewayTimeoutsArgs
subnet This property is required. String
The unique identifier for this subnet.
accessTags List<String>
List of access management tags
isVpnGatewayId String
(String) - The unique identifier for this VPC.
mode String
Mode in VPN gateway. Supported values are route or policy. The default value is route.
name String
The name of the VPN gateway.
resourceGroup String
The resource group (id), where the VPN gateway to be created.
tags List<String>
A list of tags that you want to add to your VPN gateway. Tags can help you find your VPN gateway more easily later.
timeouts IsVpnGatewayTimeouts
subnet This property is required. string
The unique identifier for this subnet.
accessTags string[]
List of access management tags
isVpnGatewayId string
(String) - The unique identifier for this VPC.
mode string
Mode in VPN gateway. Supported values are route or policy. The default value is route.
name string
The name of the VPN gateway.
resourceGroup string
The resource group (id), where the VPN gateway to be created.
tags string[]
A list of tags that you want to add to your VPN gateway. Tags can help you find your VPN gateway more easily later.
timeouts IsVpnGatewayTimeouts
subnet This property is required. str
The unique identifier for this subnet.
access_tags Sequence[str]
List of access management tags
is_vpn_gateway_id str
(String) - The unique identifier for this VPC.
mode str
Mode in VPN gateway. Supported values are route or policy. The default value is route.
name str
The name of the VPN gateway.
resource_group str
The resource group (id), where the VPN gateway to be created.
tags Sequence[str]
A list of tags that you want to add to your VPN gateway. Tags can help you find your VPN gateway more easily later.
timeouts IsVpnGatewayTimeoutsArgs
subnet This property is required. String
The unique identifier for this subnet.
accessTags List<String>
List of access management tags
isVpnGatewayId String
(String) - The unique identifier for this VPC.
mode String
Mode in VPN gateway. Supported values are route or policy. The default value is route.
name String
The name of the VPN gateway.
resourceGroup String
The resource group (id), where the VPN gateway to be created.
tags List<String>
A list of tags that you want to add to your VPN gateway. Tags can help you find your VPN gateway more easily later.
timeouts Property Map

Outputs

All input properties are implicitly available as output properties. Additionally, the IsVpnGateway resource produces the following output properties:

CreatedAt string
(String) The Second IP address assigned to this VPN gateway.
Crn string
(String) The CRN for this VPC.
HealthReasons List<IsVpnGatewayHealthReason>
(List) The reasons for the current health_state (if any).
HealthState string
(String) The health of this resource.
Id string
The provider-assigned unique ID for this managed resource.
LifecycleReasons List<IsVpnGatewayLifecycleReason>
(List) The reasons for the current lifecycle_reasons (if any).
LifecycleState string
(String) The lifecycle state of the VPN gateway.
Members List<IsVpnGatewayMember>
(List) Collection of VPN gateway members.
PrivateIpAddress string
(String) The Private IP address assigned to this VPN gateway member.
PrivateIpAddress2 string
(String) The Second Private IP address assigned to this VPN gateway.
PublicIpAddress string
(String) The IP address assigned to this VPN gateway.
PublicIpAddress2 string
(String) The Second Public IP address assigned to this VPN gateway member.
ResourceControllerUrl string
The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
ResourceCrn string
The crn of the resource
ResourceGroupName string
The resource group name in which resource is provisioned
ResourceName string
The name of the resource
ResourceStatus string
The status of the resource
Status string
The status of the VPN gateway
Vpcs List<IsVpnGatewayVpc>
(String) The VPC this VPN server resides in. Nested scheme for vpc:
CreatedAt string
(String) The Second IP address assigned to this VPN gateway.
Crn string
(String) The CRN for this VPC.
HealthReasons []IsVpnGatewayHealthReason
(List) The reasons for the current health_state (if any).
HealthState string
(String) The health of this resource.
Id string
The provider-assigned unique ID for this managed resource.
LifecycleReasons []IsVpnGatewayLifecycleReason
(List) The reasons for the current lifecycle_reasons (if any).
LifecycleState string
(String) The lifecycle state of the VPN gateway.
Members []IsVpnGatewayMember
(List) Collection of VPN gateway members.
PrivateIpAddress string
(String) The Private IP address assigned to this VPN gateway member.
PrivateIpAddress2 string
(String) The Second Private IP address assigned to this VPN gateway.
PublicIpAddress string
(String) The IP address assigned to this VPN gateway.
PublicIpAddress2 string
(String) The Second Public IP address assigned to this VPN gateway member.
ResourceControllerUrl string
The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
ResourceCrn string
The crn of the resource
ResourceGroupName string
The resource group name in which resource is provisioned
ResourceName string
The name of the resource
ResourceStatus string
The status of the resource
Status string
The status of the VPN gateway
Vpcs []IsVpnGatewayVpc
(String) The VPC this VPN server resides in. Nested scheme for vpc:
createdAt String
(String) The Second IP address assigned to this VPN gateway.
crn String
(String) The CRN for this VPC.
healthReasons List<IsVpnGatewayHealthReason>
(List) The reasons for the current health_state (if any).
healthState String
(String) The health of this resource.
id String
The provider-assigned unique ID for this managed resource.
lifecycleReasons List<IsVpnGatewayLifecycleReason>
(List) The reasons for the current lifecycle_reasons (if any).
lifecycleState String
(String) The lifecycle state of the VPN gateway.
members List<IsVpnGatewayMember>
(List) Collection of VPN gateway members.
privateIpAddress String
(String) The Private IP address assigned to this VPN gateway member.
privateIpAddress2 String
(String) The Second Private IP address assigned to this VPN gateway.
publicIpAddress String
(String) The IP address assigned to this VPN gateway.
publicIpAddress2 String
(String) The Second Public IP address assigned to this VPN gateway member.
resourceControllerUrl String
The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
resourceCrn String
The crn of the resource
resourceGroupName String
The resource group name in which resource is provisioned
resourceName String
The name of the resource
resourceStatus String
The status of the resource
status String
The status of the VPN gateway
vpcs List<IsVpnGatewayVpc>
(String) The VPC this VPN server resides in. Nested scheme for vpc:
createdAt string
(String) The Second IP address assigned to this VPN gateway.
crn string
(String) The CRN for this VPC.
healthReasons IsVpnGatewayHealthReason[]
(List) The reasons for the current health_state (if any).
healthState string
(String) The health of this resource.
id string
The provider-assigned unique ID for this managed resource.
lifecycleReasons IsVpnGatewayLifecycleReason[]
(List) The reasons for the current lifecycle_reasons (if any).
lifecycleState string
(String) The lifecycle state of the VPN gateway.
members IsVpnGatewayMember[]
(List) Collection of VPN gateway members.
privateIpAddress string
(String) The Private IP address assigned to this VPN gateway member.
privateIpAddress2 string
(String) The Second Private IP address assigned to this VPN gateway.
publicIpAddress string
(String) The IP address assigned to this VPN gateway.
publicIpAddress2 string
(String) The Second Public IP address assigned to this VPN gateway member.
resourceControllerUrl string
The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
resourceCrn string
The crn of the resource
resourceGroupName string
The resource group name in which resource is provisioned
resourceName string
The name of the resource
resourceStatus string
The status of the resource
status string
The status of the VPN gateway
vpcs IsVpnGatewayVpc[]
(String) The VPC this VPN server resides in. Nested scheme for vpc:
created_at str
(String) The Second IP address assigned to this VPN gateway.
crn str
(String) The CRN for this VPC.
health_reasons Sequence[IsVpnGatewayHealthReason]
(List) The reasons for the current health_state (if any).
health_state str
(String) The health of this resource.
id str
The provider-assigned unique ID for this managed resource.
lifecycle_reasons Sequence[IsVpnGatewayLifecycleReason]
(List) The reasons for the current lifecycle_reasons (if any).
lifecycle_state str
(String) The lifecycle state of the VPN gateway.
members Sequence[IsVpnGatewayMember]
(List) Collection of VPN gateway members.
private_ip_address str
(String) The Private IP address assigned to this VPN gateway member.
private_ip_address2 str
(String) The Second Private IP address assigned to this VPN gateway.
public_ip_address str
(String) The IP address assigned to this VPN gateway.
public_ip_address2 str
(String) The Second Public IP address assigned to this VPN gateway member.
resource_controller_url str
The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
resource_crn str
The crn of the resource
resource_group_name str
The resource group name in which resource is provisioned
resource_name str
The name of the resource
resource_status str
The status of the resource
status str
The status of the VPN gateway
vpcs Sequence[IsVpnGatewayVpc]
(String) The VPC this VPN server resides in. Nested scheme for vpc:
createdAt String
(String) The Second IP address assigned to this VPN gateway.
crn String
(String) The CRN for this VPC.
healthReasons List<Property Map>
(List) The reasons for the current health_state (if any).
healthState String
(String) The health of this resource.
id String
The provider-assigned unique ID for this managed resource.
lifecycleReasons List<Property Map>
(List) The reasons for the current lifecycle_reasons (if any).
lifecycleState String
(String) The lifecycle state of the VPN gateway.
members List<Property Map>
(List) Collection of VPN gateway members.
privateIpAddress String
(String) The Private IP address assigned to this VPN gateway member.
privateIpAddress2 String
(String) The Second Private IP address assigned to this VPN gateway.
publicIpAddress String
(String) The IP address assigned to this VPN gateway.
publicIpAddress2 String
(String) The Second Public IP address assigned to this VPN gateway member.
resourceControllerUrl String
The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
resourceCrn String
The crn of the resource
resourceGroupName String
The resource group name in which resource is provisioned
resourceName String
The name of the resource
resourceStatus String
The status of the resource
status String
The status of the VPN gateway
vpcs List<Property Map>
(String) The VPC this VPN server resides in. Nested scheme for vpc:

Look up Existing IsVpnGateway Resource

Get an existing IsVpnGateway resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: IsVpnGatewayState, opts?: CustomResourceOptions): IsVpnGateway
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_tags: Optional[Sequence[str]] = None,
        created_at: Optional[str] = None,
        crn: Optional[str] = None,
        health_reasons: Optional[Sequence[IsVpnGatewayHealthReasonArgs]] = None,
        health_state: Optional[str] = None,
        is_vpn_gateway_id: Optional[str] = None,
        lifecycle_reasons: Optional[Sequence[IsVpnGatewayLifecycleReasonArgs]] = None,
        lifecycle_state: Optional[str] = None,
        members: Optional[Sequence[IsVpnGatewayMemberArgs]] = None,
        mode: Optional[str] = None,
        name: Optional[str] = None,
        private_ip_address: Optional[str] = None,
        private_ip_address2: Optional[str] = None,
        public_ip_address: Optional[str] = None,
        public_ip_address2: Optional[str] = None,
        resource_controller_url: Optional[str] = None,
        resource_crn: Optional[str] = None,
        resource_group: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        resource_name: Optional[str] = None,
        resource_status: Optional[str] = None,
        status: Optional[str] = None,
        subnet: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        timeouts: Optional[IsVpnGatewayTimeoutsArgs] = None,
        vpcs: Optional[Sequence[IsVpnGatewayVpcArgs]] = None) -> IsVpnGateway
func GetIsVpnGateway(ctx *Context, name string, id IDInput, state *IsVpnGatewayState, opts ...ResourceOption) (*IsVpnGateway, error)
public static IsVpnGateway Get(string name, Input<string> id, IsVpnGatewayState? state, CustomResourceOptions? opts = null)
public static IsVpnGateway get(String name, Output<String> id, IsVpnGatewayState state, CustomResourceOptions options)
resources:  _:    type: ibm:IsVpnGateway    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AccessTags List<string>
List of access management tags
CreatedAt string
(String) The Second IP address assigned to this VPN gateway.
Crn string
(String) The CRN for this VPC.
HealthReasons List<IsVpnGatewayHealthReason>
(List) The reasons for the current health_state (if any).
HealthState string
(String) The health of this resource.
IsVpnGatewayId string
(String) - The unique identifier for this VPC.
LifecycleReasons List<IsVpnGatewayLifecycleReason>
(List) The reasons for the current lifecycle_reasons (if any).
LifecycleState string
(String) The lifecycle state of the VPN gateway.
Members List<IsVpnGatewayMember>
(List) Collection of VPN gateway members.
Mode string
Mode in VPN gateway. Supported values are route or policy. The default value is route.
Name string
The name of the VPN gateway.
PrivateIpAddress string
(String) The Private IP address assigned to this VPN gateway member.
PrivateIpAddress2 string
(String) The Second Private IP address assigned to this VPN gateway.
PublicIpAddress string
(String) The IP address assigned to this VPN gateway.
PublicIpAddress2 string
(String) The Second Public IP address assigned to this VPN gateway member.
ResourceControllerUrl string
The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
ResourceCrn string
The crn of the resource
ResourceGroup string
The resource group (id), where the VPN gateway to be created.
ResourceGroupName string
The resource group name in which resource is provisioned
ResourceName string
The name of the resource
ResourceStatus string
The status of the resource
Status string
The status of the VPN gateway
Subnet string
The unique identifier for this subnet.
Tags List<string>
A list of tags that you want to add to your VPN gateway. Tags can help you find your VPN gateway more easily later.
Timeouts IsVpnGatewayTimeouts
Vpcs List<IsVpnGatewayVpc>
(String) The VPC this VPN server resides in. Nested scheme for vpc:
AccessTags []string
List of access management tags
CreatedAt string
(String) The Second IP address assigned to this VPN gateway.
Crn string
(String) The CRN for this VPC.
HealthReasons []IsVpnGatewayHealthReasonArgs
(List) The reasons for the current health_state (if any).
HealthState string
(String) The health of this resource.
IsVpnGatewayId string
(String) - The unique identifier for this VPC.
LifecycleReasons []IsVpnGatewayLifecycleReasonArgs
(List) The reasons for the current lifecycle_reasons (if any).
LifecycleState string
(String) The lifecycle state of the VPN gateway.
Members []IsVpnGatewayMemberArgs
(List) Collection of VPN gateway members.
Mode string
Mode in VPN gateway. Supported values are route or policy. The default value is route.
Name string
The name of the VPN gateway.
PrivateIpAddress string
(String) The Private IP address assigned to this VPN gateway member.
PrivateIpAddress2 string
(String) The Second Private IP address assigned to this VPN gateway.
PublicIpAddress string
(String) The IP address assigned to this VPN gateway.
PublicIpAddress2 string
(String) The Second Public IP address assigned to this VPN gateway member.
ResourceControllerUrl string
The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
ResourceCrn string
The crn of the resource
ResourceGroup string
The resource group (id), where the VPN gateway to be created.
ResourceGroupName string
The resource group name in which resource is provisioned
ResourceName string
The name of the resource
ResourceStatus string
The status of the resource
Status string
The status of the VPN gateway
Subnet string
The unique identifier for this subnet.
Tags []string
A list of tags that you want to add to your VPN gateway. Tags can help you find your VPN gateway more easily later.
Timeouts IsVpnGatewayTimeoutsArgs
Vpcs []IsVpnGatewayVpcArgs
(String) The VPC this VPN server resides in. Nested scheme for vpc:
accessTags List<String>
List of access management tags
createdAt String
(String) The Second IP address assigned to this VPN gateway.
crn String
(String) The CRN for this VPC.
healthReasons List<IsVpnGatewayHealthReason>
(List) The reasons for the current health_state (if any).
healthState String
(String) The health of this resource.
isVpnGatewayId String
(String) - The unique identifier for this VPC.
lifecycleReasons List<IsVpnGatewayLifecycleReason>
(List) The reasons for the current lifecycle_reasons (if any).
lifecycleState String
(String) The lifecycle state of the VPN gateway.
members List<IsVpnGatewayMember>
(List) Collection of VPN gateway members.
mode String
Mode in VPN gateway. Supported values are route or policy. The default value is route.
name String
The name of the VPN gateway.
privateIpAddress String
(String) The Private IP address assigned to this VPN gateway member.
privateIpAddress2 String
(String) The Second Private IP address assigned to this VPN gateway.
publicIpAddress String
(String) The IP address assigned to this VPN gateway.
publicIpAddress2 String
(String) The Second Public IP address assigned to this VPN gateway member.
resourceControllerUrl String
The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
resourceCrn String
The crn of the resource
resourceGroup String
The resource group (id), where the VPN gateway to be created.
resourceGroupName String
The resource group name in which resource is provisioned
resourceName String
The name of the resource
resourceStatus String
The status of the resource
status String
The status of the VPN gateway
subnet String
The unique identifier for this subnet.
tags List<String>
A list of tags that you want to add to your VPN gateway. Tags can help you find your VPN gateway more easily later.
timeouts IsVpnGatewayTimeouts
vpcs List<IsVpnGatewayVpc>
(String) The VPC this VPN server resides in. Nested scheme for vpc:
accessTags string[]
List of access management tags
createdAt string
(String) The Second IP address assigned to this VPN gateway.
crn string
(String) The CRN for this VPC.
healthReasons IsVpnGatewayHealthReason[]
(List) The reasons for the current health_state (if any).
healthState string
(String) The health of this resource.
isVpnGatewayId string
(String) - The unique identifier for this VPC.
lifecycleReasons IsVpnGatewayLifecycleReason[]
(List) The reasons for the current lifecycle_reasons (if any).
lifecycleState string
(String) The lifecycle state of the VPN gateway.
members IsVpnGatewayMember[]
(List) Collection of VPN gateway members.
mode string
Mode in VPN gateway. Supported values are route or policy. The default value is route.
name string
The name of the VPN gateway.
privateIpAddress string
(String) The Private IP address assigned to this VPN gateway member.
privateIpAddress2 string
(String) The Second Private IP address assigned to this VPN gateway.
publicIpAddress string
(String) The IP address assigned to this VPN gateway.
publicIpAddress2 string
(String) The Second Public IP address assigned to this VPN gateway member.
resourceControllerUrl string
The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
resourceCrn string
The crn of the resource
resourceGroup string
The resource group (id), where the VPN gateway to be created.
resourceGroupName string
The resource group name in which resource is provisioned
resourceName string
The name of the resource
resourceStatus string
The status of the resource
status string
The status of the VPN gateway
subnet string
The unique identifier for this subnet.
tags string[]
A list of tags that you want to add to your VPN gateway. Tags can help you find your VPN gateway more easily later.
timeouts IsVpnGatewayTimeouts
vpcs IsVpnGatewayVpc[]
(String) The VPC this VPN server resides in. Nested scheme for vpc:
access_tags Sequence[str]
List of access management tags
created_at str
(String) The Second IP address assigned to this VPN gateway.
crn str
(String) The CRN for this VPC.
health_reasons Sequence[IsVpnGatewayHealthReasonArgs]
(List) The reasons for the current health_state (if any).
health_state str
(String) The health of this resource.
is_vpn_gateway_id str
(String) - The unique identifier for this VPC.
lifecycle_reasons Sequence[IsVpnGatewayLifecycleReasonArgs]
(List) The reasons for the current lifecycle_reasons (if any).
lifecycle_state str
(String) The lifecycle state of the VPN gateway.
members Sequence[IsVpnGatewayMemberArgs]
(List) Collection of VPN gateway members.
mode str
Mode in VPN gateway. Supported values are route or policy. The default value is route.
name str
The name of the VPN gateway.
private_ip_address str
(String) The Private IP address assigned to this VPN gateway member.
private_ip_address2 str
(String) The Second Private IP address assigned to this VPN gateway.
public_ip_address str
(String) The IP address assigned to this VPN gateway.
public_ip_address2 str
(String) The Second Public IP address assigned to this VPN gateway member.
resource_controller_url str
The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
resource_crn str
The crn of the resource
resource_group str
The resource group (id), where the VPN gateway to be created.
resource_group_name str
The resource group name in which resource is provisioned
resource_name str
The name of the resource
resource_status str
The status of the resource
status str
The status of the VPN gateway
subnet str
The unique identifier for this subnet.
tags Sequence[str]
A list of tags that you want to add to your VPN gateway. Tags can help you find your VPN gateway more easily later.
timeouts IsVpnGatewayTimeoutsArgs
vpcs Sequence[IsVpnGatewayVpcArgs]
(String) The VPC this VPN server resides in. Nested scheme for vpc:
accessTags List<String>
List of access management tags
createdAt String
(String) The Second IP address assigned to this VPN gateway.
crn String
(String) The CRN for this VPC.
healthReasons List<Property Map>
(List) The reasons for the current health_state (if any).
healthState String
(String) The health of this resource.
isVpnGatewayId String
(String) - The unique identifier for this VPC.
lifecycleReasons List<Property Map>
(List) The reasons for the current lifecycle_reasons (if any).
lifecycleState String
(String) The lifecycle state of the VPN gateway.
members List<Property Map>
(List) Collection of VPN gateway members.
mode String
Mode in VPN gateway. Supported values are route or policy. The default value is route.
name String
The name of the VPN gateway.
privateIpAddress String
(String) The Private IP address assigned to this VPN gateway member.
privateIpAddress2 String
(String) The Second Private IP address assigned to this VPN gateway.
publicIpAddress String
(String) The IP address assigned to this VPN gateway.
publicIpAddress2 String
(String) The Second Public IP address assigned to this VPN gateway member.
resourceControllerUrl String
The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
resourceCrn String
The crn of the resource
resourceGroup String
The resource group (id), where the VPN gateway to be created.
resourceGroupName String
The resource group name in which resource is provisioned
resourceName String
The name of the resource
resourceStatus String
The status of the resource
status String
The status of the VPN gateway
subnet String
The unique identifier for this subnet.
tags List<String>
A list of tags that you want to add to your VPN gateway. Tags can help you find your VPN gateway more easily later.
timeouts Property Map
vpcs List<Property Map>
(String) The VPC this VPN server resides in. Nested scheme for vpc:

Supporting Types

IsVpnGatewayHealthReason
, IsVpnGatewayHealthReasonArgs

Code This property is required. string
(String) A snake case string succinctly identifying the reason for this lifecycle reason.
Message This property is required. string
(String) An explanation of the reason for this lifecycle reason.
MoreInfo This property is required. string
(String) Link to documentation about deleted resources.
Code This property is required. string
(String) A snake case string succinctly identifying the reason for this lifecycle reason.
Message This property is required. string
(String) An explanation of the reason for this lifecycle reason.
MoreInfo This property is required. string
(String) Link to documentation about deleted resources.
code This property is required. String
(String) A snake case string succinctly identifying the reason for this lifecycle reason.
message This property is required. String
(String) An explanation of the reason for this lifecycle reason.
moreInfo This property is required. String
(String) Link to documentation about deleted resources.
code This property is required. string
(String) A snake case string succinctly identifying the reason for this lifecycle reason.
message This property is required. string
(String) An explanation of the reason for this lifecycle reason.
moreInfo This property is required. string
(String) Link to documentation about deleted resources.
code This property is required. str
(String) A snake case string succinctly identifying the reason for this lifecycle reason.
message This property is required. str
(String) An explanation of the reason for this lifecycle reason.
more_info This property is required. str
(String) Link to documentation about deleted resources.
code This property is required. String
(String) A snake case string succinctly identifying the reason for this lifecycle reason.
message This property is required. String
(String) An explanation of the reason for this lifecycle reason.
moreInfo This property is required. String
(String) Link to documentation about deleted resources.

IsVpnGatewayLifecycleReason
, IsVpnGatewayLifecycleReasonArgs

Code This property is required. string
(String) A snake case string succinctly identifying the reason for this lifecycle reason.
Message This property is required. string
(String) An explanation of the reason for this lifecycle reason.
MoreInfo This property is required. string
(String) Link to documentation about deleted resources.
Code This property is required. string
(String) A snake case string succinctly identifying the reason for this lifecycle reason.
Message This property is required. string
(String) An explanation of the reason for this lifecycle reason.
MoreInfo This property is required. string
(String) Link to documentation about deleted resources.
code This property is required. String
(String) A snake case string succinctly identifying the reason for this lifecycle reason.
message This property is required. String
(String) An explanation of the reason for this lifecycle reason.
moreInfo This property is required. String
(String) Link to documentation about deleted resources.
code This property is required. string
(String) A snake case string succinctly identifying the reason for this lifecycle reason.
message This property is required. string
(String) An explanation of the reason for this lifecycle reason.
moreInfo This property is required. string
(String) Link to documentation about deleted resources.
code This property is required. str
(String) A snake case string succinctly identifying the reason for this lifecycle reason.
message This property is required. str
(String) An explanation of the reason for this lifecycle reason.
more_info This property is required. str
(String) Link to documentation about deleted resources.
code This property is required. String
(String) A snake case string succinctly identifying the reason for this lifecycle reason.
message This property is required. String
(String) An explanation of the reason for this lifecycle reason.
moreInfo This property is required. String
(String) Link to documentation about deleted resources.

IsVpnGatewayMember
, IsVpnGatewayMemberArgs

Address This property is required. string
(String) The public IP address assigned to the VPN gateway member.
PrivateAddress This property is required. string
(String) The private IP address assigned to the VPN gateway member.
Role This property is required. string
(String) The high availability role assigned to the VPN gateway member.
Status This property is required. string
Address This property is required. string
(String) The public IP address assigned to the VPN gateway member.
PrivateAddress This property is required. string
(String) The private IP address assigned to the VPN gateway member.
Role This property is required. string
(String) The high availability role assigned to the VPN gateway member.
Status This property is required. string
address This property is required. String
(String) The public IP address assigned to the VPN gateway member.
privateAddress This property is required. String
(String) The private IP address assigned to the VPN gateway member.
role This property is required. String
(String) The high availability role assigned to the VPN gateway member.
status This property is required. String
address This property is required. string
(String) The public IP address assigned to the VPN gateway member.
privateAddress This property is required. string
(String) The private IP address assigned to the VPN gateway member.
role This property is required. string
(String) The high availability role assigned to the VPN gateway member.
status This property is required. string
address This property is required. str
(String) The public IP address assigned to the VPN gateway member.
private_address This property is required. str
(String) The private IP address assigned to the VPN gateway member.
role This property is required. str
(String) The high availability role assigned to the VPN gateway member.
status This property is required. str
address This property is required. String
(String) The public IP address assigned to the VPN gateway member.
privateAddress This property is required. String
(String) The private IP address assigned to the VPN gateway member.
role This property is required. String
(String) The high availability role assigned to the VPN gateway member.
status This property is required. String

IsVpnGatewayTimeouts
, IsVpnGatewayTimeoutsArgs

Create string
Delete string
Create string
Delete string
create String
delete String
create string
delete string
create str
delete str
create String
delete String

IsVpnGatewayVpc
, IsVpnGatewayVpcArgs

Crn This property is required. string
(String) The CRN for this VPC.
Deleteds This property is required. List<IsVpnGatewayVpcDeleted>
(List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information. Nested scheme for deleted:
Href This property is required. string
(String) - The URL for this VPC
Id This property is required. string
(String) - The unique identifier for this VPC.
Name This property is required. string
The name of the VPN gateway.
Crn This property is required. string
(String) The CRN for this VPC.
Deleteds This property is required. []IsVpnGatewayVpcDeleted
(List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information. Nested scheme for deleted:
Href This property is required. string
(String) - The URL for this VPC
Id This property is required. string
(String) - The unique identifier for this VPC.
Name This property is required. string
The name of the VPN gateway.
crn This property is required. String
(String) The CRN for this VPC.
deleteds This property is required. List<IsVpnGatewayVpcDeleted>
(List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information. Nested scheme for deleted:
href This property is required. String
(String) - The URL for this VPC
id This property is required. String
(String) - The unique identifier for this VPC.
name This property is required. String
The name of the VPN gateway.
crn This property is required. string
(String) The CRN for this VPC.
deleteds This property is required. IsVpnGatewayVpcDeleted[]
(List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information. Nested scheme for deleted:
href This property is required. string
(String) - The URL for this VPC
id This property is required. string
(String) - The unique identifier for this VPC.
name This property is required. string
The name of the VPN gateway.
crn This property is required. str
(String) The CRN for this VPC.
deleteds This property is required. Sequence[IsVpnGatewayVpcDeleted]
(List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information. Nested scheme for deleted:
href This property is required. str
(String) - The URL for this VPC
id This property is required. str
(String) - The unique identifier for this VPC.
name This property is required. str
The name of the VPN gateway.
crn This property is required. String
(String) The CRN for this VPC.
deleteds This property is required. List<Property Map>
(List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information. Nested scheme for deleted:
href This property is required. String
(String) - The URL for this VPC
id This property is required. String
(String) - The unique identifier for this VPC.
name This property is required. String
The name of the VPN gateway.

IsVpnGatewayVpcDeleted
, IsVpnGatewayVpcDeletedArgs

MoreInfo This property is required. string
(String) Link to documentation about deleted resources.
MoreInfo This property is required. string
(String) Link to documentation about deleted resources.
moreInfo This property is required. String
(String) Link to documentation about deleted resources.
moreInfo This property is required. string
(String) Link to documentation about deleted resources.
more_info This property is required. str
(String) Link to documentation about deleted resources.
moreInfo This property is required. String
(String) Link to documentation about deleted resources.

Import

The ibm_is_vpn_gateway resource can be imported by using the VPN gateway ID.

Syntax

$ pulumi import ibm:index/isVpnGateway:IsVpnGateway example <vpn_gateway_ID>
Copy

Example

$ pulumi import ibm:index/isVpnGateway:IsVpnGateway example d7bec597-4726-451f-8a63-e621111119c32c
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
ibm ibm-cloud/terraform-provider-ibm
License
Notes
This Pulumi package is based on the ibm Terraform Provider.
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm