published on Thursday, Nov 5, 2026 by ibm-cloud
published on Thursday, Nov 5, 2026 by ibm-cloud
Import
Using pulumi import. For example:
$ pulumi import ibm:index/isVpnGateway:IsVpnGateway example <vpn_gateway_ID>
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: Optional[IsVpnGatewayArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def IsVpnGateway(resource_name: str,
opts: Optional[ResourceOptions] = None,
access_tags: Optional[Sequence[str]] = None,
availability_mode: Optional[str] = None,
is_vpn_gateway_id: Optional[str] = None,
local_asn: Optional[float] = None,
members: Optional[Sequence[IsVpnGatewayMemberArgs]] = None,
mode: Optional[str] = None,
name: Optional[str] = None,
resource_group: Optional[str] = None,
subnet: 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 = null, 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.
resource "ibm_is_vpn_gateway" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args IsVpnGatewayArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args 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 string
- The unique name of the resource.
- args IsVpnGatewayArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args IsVpnGatewayArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args 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()
{
AccessTags = new[]
{
"string",
},
AvailabilityMode = "string",
IsVpnGatewayId = "string",
LocalAsn = 0.0,
Members = new[]
{
new Ibm.Inputs.IsVpnGatewayMemberArgs
{
Address = "string",
HealthReasons = new[]
{
new Ibm.Inputs.IsVpnGatewayMemberHealthReasonArgs
{
Code = "string",
Message = "string",
MoreInfo = "string",
},
},
HealthState = "string",
Id = "string",
LifecycleReasons = new[]
{
new Ibm.Inputs.IsVpnGatewayMemberLifecycleReasonArgs
{
Code = "string",
Message = "string",
MoreInfo = "string",
},
},
LifecycleState = "string",
PrivateAddress = "string",
PrivateIp = new Ibm.Inputs.IsVpnGatewayMemberPrivateIpArgs
{
Address = "string",
Deleteds = new[]
{
new Ibm.Inputs.IsVpnGatewayMemberPrivateIpDeletedArgs
{
MoreInfo = "string",
},
},
Href = "string",
Id = "string",
Name = "string",
ResourceType = "string",
Subnet = new Ibm.Inputs.IsVpnGatewayMemberPrivateIpSubnetArgs
{
Crn = "string",
Deleteds = new[]
{
new Ibm.Inputs.IsVpnGatewayMemberPrivateIpSubnetDeletedArgs
{
MoreInfo = "string",
},
},
Href = "string",
Id = "string",
Name = "string",
ResourceType = "string",
},
},
PublicIps = new[]
{
new Ibm.Inputs.IsVpnGatewayMemberPublicIpArgs
{
Address = "string",
},
},
Role = "string",
Status = "string",
},
},
Mode = "string",
Name = "string",
ResourceGroup = "string",
Subnet = "string",
Tags = new[]
{
"string",
},
Timeouts = new Ibm.Inputs.IsVpnGatewayTimeoutsArgs
{
Create = "string",
Delete = "string",
},
});
example, err := ibm.NewIsVpnGateway(ctx, "isVpnGatewayResource", &ibm.IsVpnGatewayArgs{
AccessTags: pulumi.StringArray{
pulumi.String("string"),
},
AvailabilityMode: pulumi.String("string"),
IsVpnGatewayId: pulumi.String("string"),
LocalAsn: pulumi.Float64(0),
Members: ibm.IsVpnGatewayMemberArray{
&ibm.IsVpnGatewayMemberArgs{
Address: pulumi.String("string"),
HealthReasons: ibm.IsVpnGatewayMemberHealthReasonArray{
&ibm.IsVpnGatewayMemberHealthReasonArgs{
Code: pulumi.String("string"),
Message: pulumi.String("string"),
MoreInfo: pulumi.String("string"),
},
},
HealthState: pulumi.String("string"),
Id: pulumi.String("string"),
LifecycleReasons: ibm.IsVpnGatewayMemberLifecycleReasonArray{
&ibm.IsVpnGatewayMemberLifecycleReasonArgs{
Code: pulumi.String("string"),
Message: pulumi.String("string"),
MoreInfo: pulumi.String("string"),
},
},
LifecycleState: pulumi.String("string"),
PrivateAddress: pulumi.String("string"),
PrivateIp: &ibm.IsVpnGatewayMemberPrivateIpArgs{
Address: pulumi.String("string"),
Deleteds: ibm.IsVpnGatewayMemberPrivateIpDeletedArray{
&ibm.IsVpnGatewayMemberPrivateIpDeletedArgs{
MoreInfo: pulumi.String("string"),
},
},
Href: pulumi.String("string"),
Id: pulumi.String("string"),
Name: pulumi.String("string"),
ResourceType: pulumi.String("string"),
Subnet: &ibm.IsVpnGatewayMemberPrivateIpSubnetArgs{
Crn: pulumi.String("string"),
Deleteds: ibm.IsVpnGatewayMemberPrivateIpSubnetDeletedArray{
&ibm.IsVpnGatewayMemberPrivateIpSubnetDeletedArgs{
MoreInfo: pulumi.String("string"),
},
},
Href: pulumi.String("string"),
Id: pulumi.String("string"),
Name: pulumi.String("string"),
ResourceType: pulumi.String("string"),
},
},
PublicIps: ibm.IsVpnGatewayMemberPublicIpArray{
&ibm.IsVpnGatewayMemberPublicIpArgs{
Address: pulumi.String("string"),
},
},
Role: pulumi.String("string"),
Status: pulumi.String("string"),
},
},
Mode: pulumi.String("string"),
Name: pulumi.String("string"),
ResourceGroup: pulumi.String("string"),
Subnet: pulumi.String("string"),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
Timeouts: &ibm.IsVpnGatewayTimeoutsArgs{
Create: pulumi.String("string"),
Delete: pulumi.String("string"),
},
})
resource "ibm_is_vpn_gateway" "isVpnGatewayResource" {
lifecycle {
create_before_destroy = true
}
access_tags = ["string"]
availability_mode = "string"
is_vpn_gateway_id = "string"
local_asn = 0
members {
address = "string"
health_reasons {
code = "string"
message = "string"
more_info = "string"
}
health_state = "string"
id = "string"
lifecycle_reasons {
code = "string"
message = "string"
more_info = "string"
}
lifecycle_state = "string"
private_address = "string"
private_ip = {
address = "string"
deleteds = [{
more_info = "string"
}]
href = "string"
id = "string"
name = "string"
resource_type = "string"
subnet = {
crn = "string"
deleteds = [{
more_info = "string"
}]
href = "string"
id = "string"
name = "string"
resource_type = "string"
}
}
public_ips {
address = "string"
}
role = "string"
status = "string"
}
mode = "string"
name = "string"
resource_group = "string"
subnet = "string"
tags = ["string"]
_ {
timeouts = {
create = "string"
delete = "string"
}
}
}
var isVpnGatewayResource = new IsVpnGateway("isVpnGatewayResource", IsVpnGatewayArgs.builder()
.accessTags("string")
.availabilityMode("string")
.isVpnGatewayId("string")
.localAsn(0.0)
.members(IsVpnGatewayMemberArgs.builder()
.address("string")
.healthReasons(IsVpnGatewayMemberHealthReasonArgs.builder()
.code("string")
.message("string")
.moreInfo("string")
.build())
.healthState("string")
.id("string")
.lifecycleReasons(IsVpnGatewayMemberLifecycleReasonArgs.builder()
.code("string")
.message("string")
.moreInfo("string")
.build())
.lifecycleState("string")
.privateAddress("string")
.privateIp(IsVpnGatewayMemberPrivateIpArgs.builder()
.address("string")
.deleteds(IsVpnGatewayMemberPrivateIpDeletedArgs.builder()
.moreInfo("string")
.build())
.href("string")
.id("string")
.name("string")
.resourceType("string")
.subnet(IsVpnGatewayMemberPrivateIpSubnetArgs.builder()
.crn("string")
.deleteds(IsVpnGatewayMemberPrivateIpSubnetDeletedArgs.builder()
.moreInfo("string")
.build())
.href("string")
.id("string")
.name("string")
.resourceType("string")
.build())
.build())
.publicIps(IsVpnGatewayMemberPublicIpArgs.builder()
.address("string")
.build())
.role("string")
.status("string")
.build())
.mode("string")
.name("string")
.resourceGroup("string")
.subnet("string")
.tags("string")
.timeouts(IsVpnGatewayTimeoutsArgs.builder()
.create("string")
.delete("string")
.build())
.build());
is_vpn_gateway_resource = ibm.IsVpnGateway("isVpnGatewayResource",
access_tags=["string"],
availability_mode="string",
is_vpn_gateway_id="string",
local_asn=float(0),
members=[{
"address": "string",
"health_reasons": [{
"code": "string",
"message": "string",
"more_info": "string",
}],
"health_state": "string",
"id": "string",
"lifecycle_reasons": [{
"code": "string",
"message": "string",
"more_info": "string",
}],
"lifecycle_state": "string",
"private_address": "string",
"private_ip": {
"address": "string",
"deleteds": [{
"more_info": "string",
}],
"href": "string",
"id": "string",
"name": "string",
"resource_type": "string",
"subnet": {
"crn": "string",
"deleteds": [{
"more_info": "string",
}],
"href": "string",
"id": "string",
"name": "string",
"resource_type": "string",
},
},
"public_ips": [{
"address": "string",
}],
"role": "string",
"status": "string",
}],
mode="string",
name="string",
resource_group="string",
subnet="string",
tags=["string"],
timeouts={
"create": "string",
"delete": "string",
})
const isVpnGatewayResource = new ibm.IsVpnGateway("isVpnGatewayResource", {
accessTags: ["string"],
availabilityMode: "string",
isVpnGatewayId: "string",
localAsn: 0,
members: [{
address: "string",
healthReasons: [{
code: "string",
message: "string",
moreInfo: "string",
}],
healthState: "string",
id: "string",
lifecycleReasons: [{
code: "string",
message: "string",
moreInfo: "string",
}],
lifecycleState: "string",
privateAddress: "string",
privateIp: {
address: "string",
deleteds: [{
moreInfo: "string",
}],
href: "string",
id: "string",
name: "string",
resourceType: "string",
subnet: {
crn: "string",
deleteds: [{
moreInfo: "string",
}],
href: "string",
id: "string",
name: "string",
resourceType: "string",
},
},
publicIps: [{
address: "string",
}],
role: "string",
status: "string",
}],
mode: "string",
name: "string",
resourceGroup: "string",
subnet: "string",
tags: ["string"],
timeouts: {
create: "string",
"delete": "string",
},
});
type: ibm:IsVpnGateway
properties:
accessTags:
- string
availabilityMode: string
isVpnGatewayId: string
localAsn: 0
members:
- address: string
healthReasons:
- code: string
message: string
moreInfo: string
healthState: string
id: string
lifecycleReasons:
- code: string
message: string
moreInfo: string
lifecycleState: string
privateAddress: string
privateIp:
address: string
deleteds:
- moreInfo: string
href: string
id: string
name: string
resourceType: string
subnet:
crn: string
deleteds:
- moreInfo: string
href: string
id: string
name: string
resourceType: string
publicIps:
- address: string
role: string
status: string
mode: string
name: string
resourceGroup: string
subnet: string
tags:
- string
timeouts:
create: string
delete: string
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:
- List<string>
- List of access management tags
- Availability
Mode string - The availability mode of the VPN gateway. Allowable values are
zonalandregional. If not set, the gateway iszonal. - Is
Vpn stringGateway Id - (String) - The unique identifier for this VPC.
- Local
Asn double - The local autonomous system number (ASN) for this VPN gateway and its connections.
- Members
List<Is
Vpn Gateway Member> The members of a regional VPN gateway. Required when
availability_modeisregional, with exactly 2 items. Must not be set for a zonal gateway.Nested scheme for
members:- Mode string
- Mode in VPN gateway. Supported values are
routeorpolicy. The default value isroute. - Name string
- The name of the VPN gateway.
- Resource
Group string - The resource group (id), where the VPN gateway to be created.
- Subnet string
- The unique identifier of the subnet for a zonal VPN gateway. Required when
availability_modeiszonalor not set. Must not be set when creating aregionalgateway. On a gateway that is alreadyregional, for example after a migration, changes tosubnetare ignored. - 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
Is
Vpn Gateway Timeouts
- []string
- List of access management tags
- Availability
Mode string - The availability mode of the VPN gateway. Allowable values are
zonalandregional. If not set, the gateway iszonal. - Is
Vpn stringGateway Id - (String) - The unique identifier for this VPC.
- Local
Asn float64 - The local autonomous system number (ASN) for this VPN gateway and its connections.
- Members
[]Is
Vpn Gateway Member Args The members of a regional VPN gateway. Required when
availability_modeisregional, with exactly 2 items. Must not be set for a zonal gateway.Nested scheme for
members:- Mode string
- Mode in VPN gateway. Supported values are
routeorpolicy. The default value isroute. - Name string
- The name of the VPN gateway.
- Resource
Group string - The resource group (id), where the VPN gateway to be created.
- Subnet string
- The unique identifier of the subnet for a zonal VPN gateway. Required when
availability_modeiszonalor not set. Must not be set when creating aregionalgateway. On a gateway that is alreadyregional, for example after a migration, changes tosubnetare ignored. - []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
Is
Vpn Gateway Timeouts Args
- list(string)
- List of access management tags
- availability_
mode string - The availability mode of the VPN gateway. Allowable values are
zonalandregional. If not set, the gateway iszonal. - is_
vpn_ stringgateway_ id - (String) - The unique identifier for this VPC.
- local_
asn number - The local autonomous system number (ASN) for this VPN gateway and its connections.
- members list(object)
The members of a regional VPN gateway. Required when
availability_modeisregional, with exactly 2 items. Must not be set for a zonal gateway.Nested scheme for
members:- mode string
- Mode in VPN gateway. Supported values are
routeorpolicy. The default value isroute. - name string
- The name of the VPN gateway.
- resource_
group string - The resource group (id), where the VPN gateway to be created.
- subnet string
- The unique identifier of the subnet for a zonal VPN gateway. Required when
availability_modeiszonalor not set. Must not be set when creating aregionalgateway. On a gateway that is alreadyregional, for example after a migration, changes tosubnetare ignored. - 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 object
- List<String>
- List of access management tags
- availability
Mode String - The availability mode of the VPN gateway. Allowable values are
zonalandregional. If not set, the gateway iszonal. - is
Vpn StringGateway Id - (String) - The unique identifier for this VPC.
- local
Asn Double - The local autonomous system number (ASN) for this VPN gateway and its connections.
- members
List<Is
Vpn Gateway Member> The members of a regional VPN gateway. Required when
availability_modeisregional, with exactly 2 items. Must not be set for a zonal gateway.Nested scheme for
members:- mode String
- Mode in VPN gateway. Supported values are
routeorpolicy. The default value isroute. - name String
- The name of the VPN gateway.
- resource
Group String - The resource group (id), where the VPN gateway to be created.
- subnet String
- The unique identifier of the subnet for a zonal VPN gateway. Required when
availability_modeiszonalor not set. Must not be set when creating aregionalgateway. On a gateway that is alreadyregional, for example after a migration, changes tosubnetare ignored. - 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
Is
Vpn Gateway Timeouts
- string[]
- List of access management tags
- availability
Mode string - The availability mode of the VPN gateway. Allowable values are
zonalandregional. If not set, the gateway iszonal. - is
Vpn stringGateway Id - (String) - The unique identifier for this VPC.
- local
Asn number - The local autonomous system number (ASN) for this VPN gateway and its connections.
- members
Is
Vpn Gateway Member[] The members of a regional VPN gateway. Required when
availability_modeisregional, with exactly 2 items. Must not be set for a zonal gateway.Nested scheme for
members:- mode string
- Mode in VPN gateway. Supported values are
routeorpolicy. The default value isroute. - name string
- The name of the VPN gateway.
- resource
Group string - The resource group (id), where the VPN gateway to be created.
- subnet string
- The unique identifier of the subnet for a zonal VPN gateway. Required when
availability_modeiszonalor not set. Must not be set when creating aregionalgateway. On a gateway that is alreadyregional, for example after a migration, changes tosubnetare ignored. - 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
Is
Vpn Gateway Timeouts
- Sequence[str]
- List of access management tags
- availability_
mode str - The availability mode of the VPN gateway. Allowable values are
zonalandregional. If not set, the gateway iszonal. - is_
vpn_ strgateway_ id - (String) - The unique identifier for this VPC.
- local_
asn float - The local autonomous system number (ASN) for this VPN gateway and its connections.
- members
Sequence[Is
Vpn Gateway Member Args] The members of a regional VPN gateway. Required when
availability_modeisregional, with exactly 2 items. Must not be set for a zonal gateway.Nested scheme for
members:- mode str
- Mode in VPN gateway. Supported values are
routeorpolicy. The default value isroute. - name str
- The name of the VPN gateway.
- resource_
group str - The resource group (id), where the VPN gateway to be created.
- subnet str
- The unique identifier of the subnet for a zonal VPN gateway. Required when
availability_modeiszonalor not set. Must not be set when creating aregionalgateway. On a gateway that is alreadyregional, for example after a migration, changes tosubnetare ignored. - 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
Is
Vpn Gateway Timeouts Args
- List<String>
- List of access management tags
- availability
Mode String - The availability mode of the VPN gateway. Allowable values are
zonalandregional. If not set, the gateway iszonal. - is
Vpn StringGateway Id - (String) - The unique identifier for this VPC.
- local
Asn Number - The local autonomous system number (ASN) for this VPN gateway and its connections.
- members List<Property Map>
The members of a regional VPN gateway. Required when
availability_modeisregional, with exactly 2 items. Must not be set for a zonal gateway.Nested scheme for
members:- mode String
- Mode in VPN gateway. Supported values are
routeorpolicy. The default value isroute. - name String
- The name of the VPN gateway.
- resource
Group String - The resource group (id), where the VPN gateway to be created.
- subnet String
- The unique identifier of the subnet for a zonal VPN gateway. Required when
availability_modeiszonalor not set. Must not be set when creating aregionalgateway. On a gateway that is alreadyregional, for example after a migration, changes tosubnetare ignored. - 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:
- Advertised
Cidrs List<string> - The additional CIDRs advertised through any enabled routing protocol (for example, BGP). The routing protocol will advertise routes with these CIDRs and VPC prefixes as route destinations.
- Created
At string - (String) The Second IP address assigned to this VPN gateway.
- Crn string
- (String) The CRN for this VPC.
- Health
Reasons List<IsVpn Gateway Health Reason> - (List) The reasons for the current health_state (if any).
- Health
State string - (String) The health of this resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Lifecycle
Reasons List<IsVpn Gateway Lifecycle Reason> - (List) The reasons for the current lifecycle_reasons (if any).
- Lifecycle
State string - (String) The lifecycle state of the VPN gateway.
- Private
Ip stringAddress - (String) The Private IP address assigned to this VPN gateway member.
- Private
Ip stringAddress2 - (String) The Second Private IP address assigned to this VPN gateway.
- Public
Ip stringAddress - (String) The IP address assigned to this VPN gateway.
- Public
Ip stringAddress2 - (String) The Second Public IP address assigned to this VPN gateway member.
- Resource
Controller stringUrl - The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
- Resource
Crn string - The crn of the resource
- Resource
Group stringName - The resource group name in which resource is provisioned
- Resource
Name string - The name of the resource
- Resource
Status string - The status of the resource
- Status string
- The status of the VPN gateway
- Vpcs
List<Is
Vpn Gateway Vpc> - (String) The VPC this VPN server resides in.
- Advertised
Cidrs []string - The additional CIDRs advertised through any enabled routing protocol (for example, BGP). The routing protocol will advertise routes with these CIDRs and VPC prefixes as route destinations.
- Created
At string - (String) The Second IP address assigned to this VPN gateway.
- Crn string
- (String) The CRN for this VPC.
- Health
Reasons []IsVpn Gateway Health Reason - (List) The reasons for the current health_state (if any).
- Health
State string - (String) The health of this resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Lifecycle
Reasons []IsVpn Gateway Lifecycle Reason - (List) The reasons for the current lifecycle_reasons (if any).
- Lifecycle
State string - (String) The lifecycle state of the VPN gateway.
- Private
Ip stringAddress - (String) The Private IP address assigned to this VPN gateway member.
- Private
Ip stringAddress2 - (String) The Second Private IP address assigned to this VPN gateway.
- Public
Ip stringAddress - (String) The IP address assigned to this VPN gateway.
- Public
Ip stringAddress2 - (String) The Second Public IP address assigned to this VPN gateway member.
- Resource
Controller stringUrl - The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
- Resource
Crn string - The crn of the resource
- Resource
Group stringName - The resource group name in which resource is provisioned
- Resource
Name string - The name of the resource
- Resource
Status string - The status of the resource
- Status string
- The status of the VPN gateway
- Vpcs
[]Is
Vpn Gateway Vpc - (String) The VPC this VPN server resides in.
- advertised_
cidrs list(string) - The additional CIDRs advertised through any enabled routing protocol (for example, BGP). The routing protocol will advertise routes with these CIDRs and VPC prefixes as route destinations.
- created_
at string - (String) The Second IP address assigned to this VPN gateway.
- crn string
- (String) The CRN for this VPC.
- health_
reasons list(object) - (List) The reasons for the current health_state (if any).
- health_
state string - (String) The health of this resource.
- id string
- The provider-assigned unique ID for this managed resource.
- lifecycle_
reasons list(object) - (List) The reasons for the current lifecycle_reasons (if any).
- lifecycle_
state string - (String) The lifecycle state of the VPN gateway.
- private_
ip_ stringaddress - (String) The Private IP address assigned to this VPN gateway member.
- private_
ip_ stringaddress2 - (String) The Second Private IP address assigned to this VPN gateway.
- public_
ip_ stringaddress - (String) The IP address assigned to this VPN gateway.
- public_
ip_ stringaddress2 - (String) The Second Public IP address assigned to this VPN gateway member.
- resource_
controller_ stringurl - The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
- resource_
crn string - The crn of the resource
- resource_
group_ stringname - The resource group name in which resource is provisioned
- resource_
name string - The name of the resource
- resource_
status string - The status of the resource
- status string
- The status of the VPN gateway
- vpcs list(object)
- (String) The VPC this VPN server resides in.
- advertised
Cidrs List<String> - The additional CIDRs advertised through any enabled routing protocol (for example, BGP). The routing protocol will advertise routes with these CIDRs and VPC prefixes as route destinations.
- created
At String - (String) The Second IP address assigned to this VPN gateway.
- crn String
- (String) The CRN for this VPC.
- health
Reasons List<IsVpn Gateway Health Reason> - (List) The reasons for the current health_state (if any).
- health
State String - (String) The health of this resource.
- id String
- The provider-assigned unique ID for this managed resource.
- lifecycle
Reasons List<IsVpn Gateway Lifecycle Reason> - (List) The reasons for the current lifecycle_reasons (if any).
- lifecycle
State String - (String) The lifecycle state of the VPN gateway.
- private
Ip StringAddress - (String) The Private IP address assigned to this VPN gateway member.
- private
Ip StringAddress2 - (String) The Second Private IP address assigned to this VPN gateway.
- public
Ip StringAddress - (String) The IP address assigned to this VPN gateway.
- public
Ip StringAddress2 - (String) The Second Public IP address assigned to this VPN gateway member.
- resource
Controller StringUrl - The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
- resource
Crn String - The crn of the resource
- resource
Group StringName - The resource group name in which resource is provisioned
- resource
Name String - The name of the resource
- resource
Status String - The status of the resource
- status String
- The status of the VPN gateway
- vpcs
List<Is
Vpn Gateway Vpc> - (String) The VPC this VPN server resides in.
- advertised
Cidrs string[] - The additional CIDRs advertised through any enabled routing protocol (for example, BGP). The routing protocol will advertise routes with these CIDRs and VPC prefixes as route destinations.
- created
At string - (String) The Second IP address assigned to this VPN gateway.
- crn string
- (String) The CRN for this VPC.
- health
Reasons IsVpn Gateway Health Reason[] - (List) The reasons for the current health_state (if any).
- health
State string - (String) The health of this resource.
- id string
- The provider-assigned unique ID for this managed resource.
- lifecycle
Reasons IsVpn Gateway Lifecycle Reason[] - (List) The reasons for the current lifecycle_reasons (if any).
- lifecycle
State string - (String) The lifecycle state of the VPN gateway.
- private
Ip stringAddress - (String) The Private IP address assigned to this VPN gateway member.
- private
Ip stringAddress2 - (String) The Second Private IP address assigned to this VPN gateway.
- public
Ip stringAddress - (String) The IP address assigned to this VPN gateway.
- public
Ip stringAddress2 - (String) The Second Public IP address assigned to this VPN gateway member.
- resource
Controller stringUrl - The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
- resource
Crn string - The crn of the resource
- resource
Group stringName - The resource group name in which resource is provisioned
- resource
Name string - The name of the resource
- resource
Status string - The status of the resource
- status string
- The status of the VPN gateway
- vpcs
Is
Vpn Gateway Vpc[] - (String) The VPC this VPN server resides in.
- advertised_
cidrs Sequence[str] - The additional CIDRs advertised through any enabled routing protocol (for example, BGP). The routing protocol will advertise routes with these CIDRs and VPC prefixes as route destinations.
- created_
at str - (String) The Second IP address assigned to this VPN gateway.
- crn str
- (String) The CRN for this VPC.
- health_
reasons Sequence[IsVpn Gateway Health Reason] - (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[IsVpn Gateway Lifecycle Reason] - (List) The reasons for the current lifecycle_reasons (if any).
- lifecycle_
state str - (String) The lifecycle state of the VPN gateway.
- private_
ip_ straddress - (String) The Private IP address assigned to this VPN gateway member.
- private_
ip_ straddress2 - (String) The Second Private IP address assigned to this VPN gateway.
- public_
ip_ straddress - (String) The IP address assigned to this VPN gateway.
- public_
ip_ straddress2 - (String) The Second Public IP address assigned to this VPN gateway member.
- resource_
controller_ strurl - 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_ strname - 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[Is
Vpn Gateway Vpc] - (String) The VPC this VPN server resides in.
- advertised
Cidrs List<String> - The additional CIDRs advertised through any enabled routing protocol (for example, BGP). The routing protocol will advertise routes with these CIDRs and VPC prefixes as route destinations.
- created
At String - (String) The Second IP address assigned to this VPN gateway.
- crn String
- (String) The CRN for this VPC.
- health
Reasons List<Property Map> - (List) The reasons for the current health_state (if any).
- health
State String - (String) The health of this resource.
- id String
- The provider-assigned unique ID for this managed resource.
- lifecycle
Reasons List<Property Map> - (List) The reasons for the current lifecycle_reasons (if any).
- lifecycle
State String - (String) The lifecycle state of the VPN gateway.
- private
Ip StringAddress - (String) The Private IP address assigned to this VPN gateway member.
- private
Ip StringAddress2 - (String) The Second Private IP address assigned to this VPN gateway.
- public
Ip StringAddress - (String) The IP address assigned to this VPN gateway.
- public
Ip StringAddress2 - (String) The Second Public IP address assigned to this VPN gateway member.
- resource
Controller StringUrl - The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
- resource
Crn String - The crn of the resource
- resource
Group StringName - The resource group name in which resource is provisioned
- resource
Name String - The name of the resource
- resource
Status 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.
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,
advertised_cidrs: Optional[Sequence[str]] = None,
availability_mode: Optional[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,
local_asn: Optional[float] = 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) -> IsVpnGatewayfunc 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}import {
to = ibm_is_vpn_gateway.example
id = "${id}"
}
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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.
- List<string>
- List of access management tags
- Advertised
Cidrs List<string> - The additional CIDRs advertised through any enabled routing protocol (for example, BGP). The routing protocol will advertise routes with these CIDRs and VPC prefixes as route destinations.
- Availability
Mode string - The availability mode of the VPN gateway. Allowable values are
zonalandregional. If not set, the gateway iszonal. - Created
At string - (String) The Second IP address assigned to this VPN gateway.
- Crn string
- (String) The CRN for this VPC.
- Health
Reasons List<IsVpn Gateway Health Reason> - (List) The reasons for the current health_state (if any).
- Health
State string - (String) The health of this resource.
- Is
Vpn stringGateway Id - (String) - The unique identifier for this VPC.
- Lifecycle
Reasons List<IsVpn Gateway Lifecycle Reason> - (List) The reasons for the current lifecycle_reasons (if any).
- Lifecycle
State string - (String) The lifecycle state of the VPN gateway.
- Local
Asn double - The local autonomous system number (ASN) for this VPN gateway and its connections.
- Members
List<Is
Vpn Gateway Member> The members of a regional VPN gateway. Required when
availability_modeisregional, with exactly 2 items. Must not be set for a zonal gateway.Nested scheme for
members:- Mode string
- Mode in VPN gateway. Supported values are
routeorpolicy. The default value isroute. - Name string
- The name of the VPN gateway.
- Private
Ip stringAddress - (String) The Private IP address assigned to this VPN gateway member.
- Private
Ip stringAddress2 - (String) The Second Private IP address assigned to this VPN gateway.
- Public
Ip stringAddress - (String) The IP address assigned to this VPN gateway.
- Public
Ip stringAddress2 - (String) The Second Public IP address assigned to this VPN gateway member.
- Resource
Controller stringUrl - The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
- Resource
Crn string - The crn of the resource
- Resource
Group string - The resource group (id), where the VPN gateway to be created.
- Resource
Group stringName - The resource group name in which resource is provisioned
- Resource
Name string - The name of the resource
- Resource
Status string - The status of the resource
- Status string
- The status of the VPN gateway
- Subnet string
- The unique identifier of the subnet for a zonal VPN gateway. Required when
availability_modeiszonalor not set. Must not be set when creating aregionalgateway. On a gateway that is alreadyregional, for example after a migration, changes tosubnetare ignored. - 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
Is
Vpn Gateway Timeouts - Vpcs
List<Is
Vpn Gateway Vpc> - (String) The VPC this VPN server resides in.
- []string
- List of access management tags
- Advertised
Cidrs []string - The additional CIDRs advertised through any enabled routing protocol (for example, BGP). The routing protocol will advertise routes with these CIDRs and VPC prefixes as route destinations.
- Availability
Mode string - The availability mode of the VPN gateway. Allowable values are
zonalandregional. If not set, the gateway iszonal. - Created
At string - (String) The Second IP address assigned to this VPN gateway.
- Crn string
- (String) The CRN for this VPC.
- Health
Reasons []IsVpn Gateway Health Reason Args - (List) The reasons for the current health_state (if any).
- Health
State string - (String) The health of this resource.
- Is
Vpn stringGateway Id - (String) - The unique identifier for this VPC.
- Lifecycle
Reasons []IsVpn Gateway Lifecycle Reason Args - (List) The reasons for the current lifecycle_reasons (if any).
- Lifecycle
State string - (String) The lifecycle state of the VPN gateway.
- Local
Asn float64 - The local autonomous system number (ASN) for this VPN gateway and its connections.
- Members
[]Is
Vpn Gateway Member Args The members of a regional VPN gateway. Required when
availability_modeisregional, with exactly 2 items. Must not be set for a zonal gateway.Nested scheme for
members:- Mode string
- Mode in VPN gateway. Supported values are
routeorpolicy. The default value isroute. - Name string
- The name of the VPN gateway.
- Private
Ip stringAddress - (String) The Private IP address assigned to this VPN gateway member.
- Private
Ip stringAddress2 - (String) The Second Private IP address assigned to this VPN gateway.
- Public
Ip stringAddress - (String) The IP address assigned to this VPN gateway.
- Public
Ip stringAddress2 - (String) The Second Public IP address assigned to this VPN gateway member.
- Resource
Controller stringUrl - The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
- Resource
Crn string - The crn of the resource
- Resource
Group string - The resource group (id), where the VPN gateway to be created.
- Resource
Group stringName - The resource group name in which resource is provisioned
- Resource
Name string - The name of the resource
- Resource
Status string - The status of the resource
- Status string
- The status of the VPN gateway
- Subnet string
- The unique identifier of the subnet for a zonal VPN gateway. Required when
availability_modeiszonalor not set. Must not be set when creating aregionalgateway. On a gateway that is alreadyregional, for example after a migration, changes tosubnetare ignored. - []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
Is
Vpn Gateway Timeouts Args - Vpcs
[]Is
Vpn Gateway Vpc Args - (String) The VPC this VPN server resides in.
- list(string)
- List of access management tags
- advertised_
cidrs list(string) - The additional CIDRs advertised through any enabled routing protocol (for example, BGP). The routing protocol will advertise routes with these CIDRs and VPC prefixes as route destinations.
- availability_
mode string - The availability mode of the VPN gateway. Allowable values are
zonalandregional. If not set, the gateway iszonal. - created_
at string - (String) The Second IP address assigned to this VPN gateway.
- crn string
- (String) The CRN for this VPC.
- health_
reasons list(object) - (List) The reasons for the current health_state (if any).
- health_
state string - (String) The health of this resource.
- is_
vpn_ stringgateway_ id - (String) - The unique identifier for this VPC.
- lifecycle_
reasons list(object) - (List) The reasons for the current lifecycle_reasons (if any).
- lifecycle_
state string - (String) The lifecycle state of the VPN gateway.
- local_
asn number - The local autonomous system number (ASN) for this VPN gateway and its connections.
- members list(object)
The members of a regional VPN gateway. Required when
availability_modeisregional, with exactly 2 items. Must not be set for a zonal gateway.Nested scheme for
members:- mode string
- Mode in VPN gateway. Supported values are
routeorpolicy. The default value isroute. - name string
- The name of the VPN gateway.
- private_
ip_ stringaddress - (String) The Private IP address assigned to this VPN gateway member.
- private_
ip_ stringaddress2 - (String) The Second Private IP address assigned to this VPN gateway.
- public_
ip_ stringaddress - (String) The IP address assigned to this VPN gateway.
- public_
ip_ stringaddress2 - (String) The Second Public IP address assigned to this VPN gateway member.
- resource_
controller_ stringurl - The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
- resource_
crn string - The crn of the resource
- resource_
group string - The resource group (id), where the VPN gateway to be created.
- resource_
group_ stringname - The resource group name in which resource is provisioned
- resource_
name string - The name of the resource
- resource_
status string - The status of the resource
- status string
- The status of the VPN gateway
- subnet string
- The unique identifier of the subnet for a zonal VPN gateway. Required when
availability_modeiszonalor not set. Must not be set when creating aregionalgateway. On a gateway that is alreadyregional, for example after a migration, changes tosubnetare ignored. - 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 object
- vpcs list(object)
- (String) The VPC this VPN server resides in.
- List<String>
- List of access management tags
- advertised
Cidrs List<String> - The additional CIDRs advertised through any enabled routing protocol (for example, BGP). The routing protocol will advertise routes with these CIDRs and VPC prefixes as route destinations.
- availability
Mode String - The availability mode of the VPN gateway. Allowable values are
zonalandregional. If not set, the gateway iszonal. - created
At String - (String) The Second IP address assigned to this VPN gateway.
- crn String
- (String) The CRN for this VPC.
- health
Reasons List<IsVpn Gateway Health Reason> - (List) The reasons for the current health_state (if any).
- health
State String - (String) The health of this resource.
- is
Vpn StringGateway Id - (String) - The unique identifier for this VPC.
- lifecycle
Reasons List<IsVpn Gateway Lifecycle Reason> - (List) The reasons for the current lifecycle_reasons (if any).
- lifecycle
State String - (String) The lifecycle state of the VPN gateway.
- local
Asn Double - The local autonomous system number (ASN) for this VPN gateway and its connections.
- members
List<Is
Vpn Gateway Member> The members of a regional VPN gateway. Required when
availability_modeisregional, with exactly 2 items. Must not be set for a zonal gateway.Nested scheme for
members:- mode String
- Mode in VPN gateway. Supported values are
routeorpolicy. The default value isroute. - name String
- The name of the VPN gateway.
- private
Ip StringAddress - (String) The Private IP address assigned to this VPN gateway member.
- private
Ip StringAddress2 - (String) The Second Private IP address assigned to this VPN gateway.
- public
Ip StringAddress - (String) The IP address assigned to this VPN gateway.
- public
Ip StringAddress2 - (String) The Second Public IP address assigned to this VPN gateway member.
- resource
Controller StringUrl - The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
- resource
Crn String - The crn of the resource
- resource
Group String - The resource group (id), where the VPN gateway to be created.
- resource
Group StringName - The resource group name in which resource is provisioned
- resource
Name String - The name of the resource
- resource
Status String - The status of the resource
- status String
- The status of the VPN gateway
- subnet String
- The unique identifier of the subnet for a zonal VPN gateway. Required when
availability_modeiszonalor not set. Must not be set when creating aregionalgateway. On a gateway that is alreadyregional, for example after a migration, changes tosubnetare ignored. - 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
Is
Vpn Gateway Timeouts - vpcs
List<Is
Vpn Gateway Vpc> - (String) The VPC this VPN server resides in.
- string[]
- List of access management tags
- advertised
Cidrs string[] - The additional CIDRs advertised through any enabled routing protocol (for example, BGP). The routing protocol will advertise routes with these CIDRs and VPC prefixes as route destinations.
- availability
Mode string - The availability mode of the VPN gateway. Allowable values are
zonalandregional. If not set, the gateway iszonal. - created
At string - (String) The Second IP address assigned to this VPN gateway.
- crn string
- (String) The CRN for this VPC.
- health
Reasons IsVpn Gateway Health Reason[] - (List) The reasons for the current health_state (if any).
- health
State string - (String) The health of this resource.
- is
Vpn stringGateway Id - (String) - The unique identifier for this VPC.
- lifecycle
Reasons IsVpn Gateway Lifecycle Reason[] - (List) The reasons for the current lifecycle_reasons (if any).
- lifecycle
State string - (String) The lifecycle state of the VPN gateway.
- local
Asn number - The local autonomous system number (ASN) for this VPN gateway and its connections.
- members
Is
Vpn Gateway Member[] The members of a regional VPN gateway. Required when
availability_modeisregional, with exactly 2 items. Must not be set for a zonal gateway.Nested scheme for
members:- mode string
- Mode in VPN gateway. Supported values are
routeorpolicy. The default value isroute. - name string
- The name of the VPN gateway.
- private
Ip stringAddress - (String) The Private IP address assigned to this VPN gateway member.
- private
Ip stringAddress2 - (String) The Second Private IP address assigned to this VPN gateway.
- public
Ip stringAddress - (String) The IP address assigned to this VPN gateway.
- public
Ip stringAddress2 - (String) The Second Public IP address assigned to this VPN gateway member.
- resource
Controller stringUrl - The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
- resource
Crn string - The crn of the resource
- resource
Group string - The resource group (id), where the VPN gateway to be created.
- resource
Group stringName - The resource group name in which resource is provisioned
- resource
Name string - The name of the resource
- resource
Status string - The status of the resource
- status string
- The status of the VPN gateway
- subnet string
- The unique identifier of the subnet for a zonal VPN gateway. Required when
availability_modeiszonalor not set. Must not be set when creating aregionalgateway. On a gateway that is alreadyregional, for example after a migration, changes tosubnetare ignored. - 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
Is
Vpn Gateway Timeouts - vpcs
Is
Vpn Gateway Vpc[] - (String) The VPC this VPN server resides in.
- Sequence[str]
- List of access management tags
- advertised_
cidrs Sequence[str] - The additional CIDRs advertised through any enabled routing protocol (for example, BGP). The routing protocol will advertise routes with these CIDRs and VPC prefixes as route destinations.
- availability_
mode str - The availability mode of the VPN gateway. Allowable values are
zonalandregional. If not set, the gateway iszonal. - created_
at str - (String) The Second IP address assigned to this VPN gateway.
- crn str
- (String) The CRN for this VPC.
- health_
reasons Sequence[IsVpn Gateway Health Reason Args] - (List) The reasons for the current health_state (if any).
- health_
state str - (String) The health of this resource.
- is_
vpn_ strgateway_ id - (String) - The unique identifier for this VPC.
- lifecycle_
reasons Sequence[IsVpn Gateway Lifecycle Reason Args] - (List) The reasons for the current lifecycle_reasons (if any).
- lifecycle_
state str - (String) The lifecycle state of the VPN gateway.
- local_
asn float - The local autonomous system number (ASN) for this VPN gateway and its connections.
- members
Sequence[Is
Vpn Gateway Member Args] The members of a regional VPN gateway. Required when
availability_modeisregional, with exactly 2 items. Must not be set for a zonal gateway.Nested scheme for
members:- mode str
- Mode in VPN gateway. Supported values are
routeorpolicy. The default value isroute. - name str
- The name of the VPN gateway.
- private_
ip_ straddress - (String) The Private IP address assigned to this VPN gateway member.
- private_
ip_ straddress2 - (String) The Second Private IP address assigned to this VPN gateway.
- public_
ip_ straddress - (String) The IP address assigned to this VPN gateway.
- public_
ip_ straddress2 - (String) The Second Public IP address assigned to this VPN gateway member.
- resource_
controller_ strurl - 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_ strname - 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 of the subnet for a zonal VPN gateway. Required when
availability_modeiszonalor not set. Must not be set when creating aregionalgateway. On a gateway that is alreadyregional, for example after a migration, changes tosubnetare ignored. - 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
Is
Vpn Gateway Timeouts Args - vpcs
Sequence[Is
Vpn Gateway Vpc Args] - (String) The VPC this VPN server resides in.
- List<String>
- List of access management tags
- advertised
Cidrs List<String> - The additional CIDRs advertised through any enabled routing protocol (for example, BGP). The routing protocol will advertise routes with these CIDRs and VPC prefixes as route destinations.
- availability
Mode String - The availability mode of the VPN gateway. Allowable values are
zonalandregional. If not set, the gateway iszonal. - created
At String - (String) The Second IP address assigned to this VPN gateway.
- crn String
- (String) The CRN for this VPC.
- health
Reasons List<Property Map> - (List) The reasons for the current health_state (if any).
- health
State String - (String) The health of this resource.
- is
Vpn StringGateway Id - (String) - The unique identifier for this VPC.
- lifecycle
Reasons List<Property Map> - (List) The reasons for the current lifecycle_reasons (if any).
- lifecycle
State String - (String) The lifecycle state of the VPN gateway.
- local
Asn Number - The local autonomous system number (ASN) for this VPN gateway and its connections.
- members List<Property Map>
The members of a regional VPN gateway. Required when
availability_modeisregional, with exactly 2 items. Must not be set for a zonal gateway.Nested scheme for
members:- mode String
- Mode in VPN gateway. Supported values are
routeorpolicy. The default value isroute. - name String
- The name of the VPN gateway.
- private
Ip StringAddress - (String) The Private IP address assigned to this VPN gateway member.
- private
Ip StringAddress2 - (String) The Second Private IP address assigned to this VPN gateway.
- public
Ip StringAddress - (String) The IP address assigned to this VPN gateway.
- public
Ip StringAddress2 - (String) The Second Public IP address assigned to this VPN gateway member.
- resource
Controller StringUrl - The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
- resource
Crn String - The crn of the resource
- resource
Group String - The resource group (id), where the VPN gateway to be created.
- resource
Group StringName - The resource group name in which resource is provisioned
- resource
Name String - The name of the resource
- resource
Status String - The status of the resource
- status String
- The status of the VPN gateway
- subnet String
- The unique identifier of the subnet for a zonal VPN gateway. Required when
availability_modeiszonalor not set. Must not be set when creating aregionalgateway. On a gateway that is alreadyregional, for example after a migration, changes tosubnetare ignored. - 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.
Supporting Types
IsVpnGatewayHealthReason, IsVpnGatewayHealthReasonArgs
IsVpnGatewayLifecycleReason, IsVpnGatewayLifecycleReasonArgs
IsVpnGatewayMember, IsVpnGatewayMemberArgs
- Address string
- (String) The IP address. The value is
0.0.0.0if the address has not been selected yet. - Health
Reasons List<IsVpn Gateway Member Health Reason> - (List) The reasons for the current health_state (if any).
- Health
State string - (String) The health of this resource.
- Id string
- (String) - The unique identifier for this VPC.
- Lifecycle
Reasons List<IsVpn Gateway Member Lifecycle Reason> - (List) The reasons for the current lifecycle_reasons (if any).
- Lifecycle
State string - (String) The lifecycle state of the VPN gateway.
- Private
Address string - (String) The private IP address assigned to the VPN gateway member. Same as
private_ip.0.address. - Private
Ip IsVpn Gateway Member Private Ip The reserved IP for the member. Exactly one item.
Nested scheme for
private_ip:- Public
Ips List<IsVpn Gateway Member Public Ip> - (List) The public IP assigned to the VPN gateway member, with
address. - Role string
- (String) The high availability role assigned to the VPN gateway member, for example
activeorstandby. - Status string
- The status of the VPN gateway member
- Address string
- (String) The IP address. The value is
0.0.0.0if the address has not been selected yet. - Health
Reasons []IsVpn Gateway Member Health Reason - (List) The reasons for the current health_state (if any).
- Health
State string - (String) The health of this resource.
- Id string
- (String) - The unique identifier for this VPC.
- Lifecycle
Reasons []IsVpn Gateway Member Lifecycle Reason - (List) The reasons for the current lifecycle_reasons (if any).
- Lifecycle
State string - (String) The lifecycle state of the VPN gateway.
- Private
Address string - (String) The private IP address assigned to the VPN gateway member. Same as
private_ip.0.address. - Private
Ip IsVpn Gateway Member Private Ip The reserved IP for the member. Exactly one item.
Nested scheme for
private_ip:- Public
Ips []IsVpn Gateway Member Public Ip - (List) The public IP assigned to the VPN gateway member, with
address. - Role string
- (String) The high availability role assigned to the VPN gateway member, for example
activeorstandby. - Status string
- The status of the VPN gateway member
- address string
- (String) The IP address. The value is
0.0.0.0if the address has not been selected yet. - health_
reasons list(object) - (List) The reasons for the current health_state (if any).
- health_
state string - (String) The health of this resource.
- id string
- (String) - The unique identifier for this VPC.
- lifecycle_
reasons list(object) - (List) The reasons for the current lifecycle_reasons (if any).
- lifecycle_
state string - (String) The lifecycle state of the VPN gateway.
- private_
address string - (String) The private IP address assigned to the VPN gateway member. Same as
private_ip.0.address. - private_
ip object The reserved IP for the member. Exactly one item.
Nested scheme for
private_ip:- public_
ips list(object) - (List) The public IP assigned to the VPN gateway member, with
address. - role string
- (String) The high availability role assigned to the VPN gateway member, for example
activeorstandby. - status string
- The status of the VPN gateway member
- address String
- (String) The IP address. The value is
0.0.0.0if the address has not been selected yet. - health
Reasons List<IsVpn Gateway Member Health Reason> - (List) The reasons for the current health_state (if any).
- health
State String - (String) The health of this resource.
- id String
- (String) - The unique identifier for this VPC.
- lifecycle
Reasons List<IsVpn Gateway Member Lifecycle Reason> - (List) The reasons for the current lifecycle_reasons (if any).
- lifecycle
State String - (String) The lifecycle state of the VPN gateway.
- private
Address String - (String) The private IP address assigned to the VPN gateway member. Same as
private_ip.0.address. - private
Ip IsVpn Gateway Member Private Ip The reserved IP for the member. Exactly one item.
Nested scheme for
private_ip:- public
Ips List<IsVpn Gateway Member Public Ip> - (List) The public IP assigned to the VPN gateway member, with
address. - role String
- (String) The high availability role assigned to the VPN gateway member, for example
activeorstandby. - status String
- The status of the VPN gateway member
- address string
- (String) The IP address. The value is
0.0.0.0if the address has not been selected yet. - health
Reasons IsVpn Gateway Member Health Reason[] - (List) The reasons for the current health_state (if any).
- health
State string - (String) The health of this resource.
- id string
- (String) - The unique identifier for this VPC.
- lifecycle
Reasons IsVpn Gateway Member Lifecycle Reason[] - (List) The reasons for the current lifecycle_reasons (if any).
- lifecycle
State string - (String) The lifecycle state of the VPN gateway.
- private
Address string - (String) The private IP address assigned to the VPN gateway member. Same as
private_ip.0.address. - private
Ip IsVpn Gateway Member Private Ip The reserved IP for the member. Exactly one item.
Nested scheme for
private_ip:- public
Ips IsVpn Gateway Member Public Ip[] - (List) The public IP assigned to the VPN gateway member, with
address. - role string
- (String) The high availability role assigned to the VPN gateway member, for example
activeorstandby. - status string
- The status of the VPN gateway member
- address str
- (String) The IP address. The value is
0.0.0.0if the address has not been selected yet. - health_
reasons Sequence[IsVpn Gateway Member Health Reason] - (List) The reasons for the current health_state (if any).
- health_
state str - (String) The health of this resource.
- id str
- (String) - The unique identifier for this VPC.
- lifecycle_
reasons Sequence[IsVpn Gateway Member Lifecycle Reason] - (List) The reasons for the current lifecycle_reasons (if any).
- lifecycle_
state str - (String) The lifecycle state of the VPN gateway.
- private_
address str - (String) The private IP address assigned to the VPN gateway member. Same as
private_ip.0.address. - private_
ip IsVpn Gateway Member Private Ip The reserved IP for the member. Exactly one item.
Nested scheme for
private_ip:- public_
ips Sequence[IsVpn Gateway Member Public Ip] - (List) The public IP assigned to the VPN gateway member, with
address. - role str
- (String) The high availability role assigned to the VPN gateway member, for example
activeorstandby. - status str
- The status of the VPN gateway member
- address String
- (String) The IP address. The value is
0.0.0.0if the address has not been selected yet. - health
Reasons List<Property Map> - (List) The reasons for the current health_state (if any).
- health
State String - (String) The health of this resource.
- id String
- (String) - The unique identifier for this VPC.
- lifecycle
Reasons List<Property Map> - (List) The reasons for the current lifecycle_reasons (if any).
- lifecycle
State String - (String) The lifecycle state of the VPN gateway.
- private
Address String - (String) The private IP address assigned to the VPN gateway member. Same as
private_ip.0.address. - private
Ip Property Map The reserved IP for the member. Exactly one item.
Nested scheme for
private_ip:- public
Ips List<Property Map> - (List) The public IP assigned to the VPN gateway member, with
address. - role String
- (String) The high availability role assigned to the VPN gateway member, for example
activeorstandby. - status String
- The status of the VPN gateway member
IsVpnGatewayMemberHealthReason, IsVpnGatewayMemberHealthReasonArgs
IsVpnGatewayMemberLifecycleReason, IsVpnGatewayMemberLifecycleReasonArgs
IsVpnGatewayMemberPrivateIp, IsVpnGatewayMemberPrivateIpArgs
- Address string
- (String) The IP address. The value is
0.0.0.0if the address has not been selected yet. - Deleteds
List<Is
Vpn Gateway Member Private Ip Deleted> - (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
- Href string
- (String) - The URL for this VPC
- Id string
- (String) - The unique identifier for this VPC.
- Name string
- The name of the VPN gateway.
- Resource
Type string - (String) - The resource type.
- Subnet
Is
Vpn Gateway Member Private Ip Subnet - The subnet to create the member in. Exactly one item. Set exactly one of the following:
- Address string
- (String) The IP address. The value is
0.0.0.0if the address has not been selected yet. - Deleteds
[]Is
Vpn Gateway Member Private Ip Deleted - (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
- Href string
- (String) - The URL for this VPC
- Id string
- (String) - The unique identifier for this VPC.
- Name string
- The name of the VPN gateway.
- Resource
Type string - (String) - The resource type.
- Subnet
Is
Vpn Gateway Member Private Ip Subnet - The subnet to create the member in. Exactly one item. Set exactly one of the following:
- address string
- (String) The IP address. The value is
0.0.0.0if the address has not been selected yet. - deleteds list(object)
- (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
- href string
- (String) - The URL for this VPC
- id string
- (String) - The unique identifier for this VPC.
- name string
- The name of the VPN gateway.
- resource_
type string - (String) - The resource type.
- subnet object
- The subnet to create the member in. Exactly one item. Set exactly one of the following:
- address String
- (String) The IP address. The value is
0.0.0.0if the address has not been selected yet. - deleteds
List<Is
Vpn Gateway Member Private Ip Deleted> - (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
- href String
- (String) - The URL for this VPC
- id String
- (String) - The unique identifier for this VPC.
- name String
- The name of the VPN gateway.
- resource
Type String - (String) - The resource type.
- subnet
Is
Vpn Gateway Member Private Ip Subnet - The subnet to create the member in. Exactly one item. Set exactly one of the following:
- address string
- (String) The IP address. The value is
0.0.0.0if the address has not been selected yet. - deleteds
Is
Vpn Gateway Member Private Ip Deleted[] - (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
- href string
- (String) - The URL for this VPC
- id string
- (String) - The unique identifier for this VPC.
- name string
- The name of the VPN gateway.
- resource
Type string - (String) - The resource type.
- subnet
Is
Vpn Gateway Member Private Ip Subnet - The subnet to create the member in. Exactly one item. Set exactly one of the following:
- address str
- (String) The IP address. The value is
0.0.0.0if the address has not been selected yet. - deleteds
Sequence[Is
Vpn Gateway Member Private Ip Deleted] - (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
- href str
- (String) - The URL for this VPC
- id str
- (String) - The unique identifier for this VPC.
- name str
- The name of the VPN gateway.
- resource_
type str - (String) - The resource type.
- subnet
Is
Vpn Gateway Member Private Ip Subnet - The subnet to create the member in. Exactly one item. Set exactly one of the following:
- address String
- (String) The IP address. The value is
0.0.0.0if the address has not been selected yet. - deleteds List<Property Map>
- (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
- href String
- (String) - The URL for this VPC
- id String
- (String) - The unique identifier for this VPC.
- name String
- The name of the VPN gateway.
- resource
Type String - (String) - The resource type.
- subnet Property Map
- The subnet to create the member in. Exactly one item. Set exactly one of the following:
IsVpnGatewayMemberPrivateIpDeleted, IsVpnGatewayMemberPrivateIpDeletedArgs
- More
Info string - (String) Link to documentation about deleted resources.
- More
Info string - (String) Link to documentation about deleted resources.
- more_
info string - (String) Link to documentation about deleted resources.
- more
Info String - (String) Link to documentation about deleted resources.
- more
Info string - (String) Link to documentation about deleted resources.
- more_
info str - (String) Link to documentation about deleted resources.
- more
Info String - (String) Link to documentation about deleted resources.
IsVpnGatewayMemberPrivateIpSubnet, IsVpnGatewayMemberPrivateIpSubnetArgs
- Crn string
- The CRN of the subnet.
- Deleteds
List<Is
Vpn Gateway Member Private Ip Subnet Deleted> - (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
- Href string
- The URL of the subnet.
- Id string
- The unique identifier for this subnet.
- Name string
- The name of the VPN gateway.
- Resource
Type string - (String) - The resource type.
- Crn string
- The CRN of the subnet.
- Deleteds
[]Is
Vpn Gateway Member Private Ip Subnet Deleted - (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
- Href string
- The URL of the subnet.
- Id string
- The unique identifier for this subnet.
- Name string
- The name of the VPN gateway.
- Resource
Type string - (String) - The resource type.
- crn string
- The CRN of the subnet.
- deleteds list(object)
- (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
- href string
- The URL of the subnet.
- id string
- The unique identifier for this subnet.
- name string
- The name of the VPN gateway.
- resource_
type string - (String) - The resource type.
- crn String
- The CRN of the subnet.
- deleteds
List<Is
Vpn Gateway Member Private Ip Subnet Deleted> - (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
- href String
- The URL of the subnet.
- id String
- The unique identifier for this subnet.
- name String
- The name of the VPN gateway.
- resource
Type String - (String) - The resource type.
- crn string
- The CRN of the subnet.
- deleteds
Is
Vpn Gateway Member Private Ip Subnet Deleted[] - (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
- href string
- The URL of the subnet.
- id string
- The unique identifier for this subnet.
- name string
- The name of the VPN gateway.
- resource
Type string - (String) - The resource type.
- crn str
- The CRN of the subnet.
- deleteds
Sequence[Is
Vpn Gateway Member Private Ip Subnet Deleted] - (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
- href str
- The URL of the subnet.
- id str
- The unique identifier for this subnet.
- name str
- The name of the VPN gateway.
- resource_
type str - (String) - The resource type.
- crn String
- The CRN of the subnet.
- deleteds List<Property Map>
- (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
- href String
- The URL of the subnet.
- id String
- The unique identifier for this subnet.
- name String
- The name of the VPN gateway.
- resource
Type String - (String) - The resource type.
IsVpnGatewayMemberPrivateIpSubnetDeleted, IsVpnGatewayMemberPrivateIpSubnetDeletedArgs
- More
Info string - (String) Link to documentation about deleted resources.
- More
Info string - (String) Link to documentation about deleted resources.
- more_
info string - (String) Link to documentation about deleted resources.
- more
Info String - (String) Link to documentation about deleted resources.
- more
Info string - (String) Link to documentation about deleted resources.
- more_
info str - (String) Link to documentation about deleted resources.
- more
Info String - (String) Link to documentation about deleted resources.
IsVpnGatewayMemberPublicIp, IsVpnGatewayMemberPublicIpArgs
- Address string
- (String) The IP address. The value is
0.0.0.0if the address has not been selected yet.
- Address string
- (String) The IP address. The value is
0.0.0.0if the address has not been selected yet.
- address string
- (String) The IP address. The value is
0.0.0.0if the address has not been selected yet.
- address String
- (String) The IP address. The value is
0.0.0.0if the address has not been selected yet.
- address string
- (String) The IP address. The value is
0.0.0.0if the address has not been selected yet.
- address str
- (String) The IP address. The value is
0.0.0.0if the address has not been selected yet.
- address String
- (String) The IP address. The value is
0.0.0.0if the address has not been selected yet.
IsVpnGatewayTimeouts, IsVpnGatewayTimeoutsArgs
IsVpnGatewayVpc, IsVpnGatewayVpcArgs
- Crn string
- (String) The CRN for this VPC.
- Deleteds
List<Is
Vpn Gateway Vpc Deleted> - (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
- Href string
- (String) - The URL for this VPC
- Id string
- (String) - The unique identifier for this VPC.
- Name string
- The name of the VPN gateway.
- Crn string
- (String) The CRN for this VPC.
- Deleteds
[]Is
Vpn Gateway Vpc Deleted - (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
- Href string
- (String) - The URL for this VPC
- Id string
- (String) - The unique identifier for this VPC.
- Name string
- The name of the VPN gateway.
- crn string
- (String) The CRN for this VPC.
- deleteds list(object)
- (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
- href string
- (String) - The URL for this VPC
- id string
- (String) - The unique identifier for this VPC.
- name string
- The name of the VPN gateway.
- crn String
- (String) The CRN for this VPC.
- deleteds
List<Is
Vpn Gateway Vpc Deleted> - (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
- href String
- (String) - The URL for this VPC
- id String
- (String) - The unique identifier for this VPC.
- name String
- The name of the VPN gateway.
- crn string
- (String) The CRN for this VPC.
- deleteds
Is
Vpn Gateway Vpc Deleted[] - (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
- href string
- (String) - The URL for this VPC
- id string
- (String) - The unique identifier for this VPC.
- name string
- The name of the VPN gateway.
- crn str
- (String) The CRN for this VPC.
- deleteds
Sequence[Is
Vpn Gateway Vpc Deleted] - (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
- href str
- (String) - The URL for this VPC
- id str
- (String) - The unique identifier for this VPC.
- name str
- The name of the VPN gateway.
- crn String
- (String) The CRN for this VPC.
- deleteds List<Property Map>
- (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
- href String
- (String) - The URL for this VPC
- id String
- (String) - The unique identifier for this VPC.
- name String
- The name of the VPN gateway.
IsVpnGatewayVpcDeleted, IsVpnGatewayVpcDeletedArgs
- More
Info string - (String) Link to documentation about deleted resources.
- More
Info string - (String) Link to documentation about deleted resources.
- more_
info string - (String) Link to documentation about deleted resources.
- more
Info String - (String) Link to documentation about deleted resources.
- more
Info string - (String) Link to documentation about deleted resources.
- more_
info str - (String) Link to documentation about deleted resources.
- more
Info String - (String) Link to documentation about deleted resources.
Package Details
- Repository
- ibm ibm-cloud/terraform-provider-ibm
- License
- Notes
- This Pulumi package is based on the
ibmTerraform Provider.
published on Thursday, Nov 5, 2026 by ibm-cloud