ibm.IsVpnGatewayConnection
Explore with Pulumi AI
Create, update, or delete a VPN gateway connection. 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";
import pulumi
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
return await Deployment.RunAsync(() =>
{
});
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) {
}
}
{}
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 example2 = new ibm.IsSubnet("example2", {
vpc: exampleIsVpc.isVpcId,
zone: "us-south-2",
ipv4CidrBlock: "10.240.68.0/24",
});
const exampleIsVpnGateway = new ibm.IsVpnGateway("exampleIsVpnGateway", {
subnet: exampleIsSubnet.isSubnetId,
mode: "route",
});
const exampleIsVpnGatewayConnection = new ibm.IsVpnGatewayConnection("exampleIsVpnGatewayConnection", {
vpnGateway: exampleIsVpnGateway.isVpnGatewayId,
presharedKey: "VPNDemoPassword",
peer: {
address: exampleIsVpnGateway.publicIpAddress,
cidrs: [example2.ipv4CidrBlock],
},
local: {
cidrs: [exampleIsSubnet.ipv4CidrBlock],
},
});
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")
example2 = ibm.IsSubnet("example2",
vpc=example_is_vpc.is_vpc_id,
zone="us-south-2",
ipv4_cidr_block="10.240.68.0/24")
example_is_vpn_gateway = ibm.IsVpnGateway("exampleIsVpnGateway",
subnet=example_is_subnet.is_subnet_id,
mode="route")
example_is_vpn_gateway_connection = ibm.IsVpnGatewayConnection("exampleIsVpnGatewayConnection",
vpn_gateway=example_is_vpn_gateway.is_vpn_gateway_id,
preshared_key="VPNDemoPassword",
peer={
"address": example_is_vpn_gateway.public_ip_address,
"cidrs": [example2.ipv4_cidr_block],
},
local={
"cidrs": [example_is_subnet.ipv4_cidr_block],
})
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
}
example2, err := ibm.NewIsSubnet(ctx, "example2", &ibm.IsSubnetArgs{
Vpc: exampleIsVpc.IsVpcId,
Zone: pulumi.String("us-south-2"),
Ipv4CidrBlock: pulumi.String("10.240.68.0/24"),
})
if err != nil {
return err
}
exampleIsVpnGateway, err := ibm.NewIsVpnGateway(ctx, "exampleIsVpnGateway", &ibm.IsVpnGatewayArgs{
Subnet: exampleIsSubnet.IsSubnetId,
Mode: pulumi.String("route"),
})
if err != nil {
return err
}
_, err = ibm.NewIsVpnGatewayConnection(ctx, "exampleIsVpnGatewayConnection", &ibm.IsVpnGatewayConnectionArgs{
VpnGateway: exampleIsVpnGateway.IsVpnGatewayId,
PresharedKey: pulumi.String("VPNDemoPassword"),
Peer: &ibm.IsVpnGatewayConnectionPeerArgs{
Address: exampleIsVpnGateway.PublicIpAddress,
Cidrs: pulumi.StringArray{
example2.Ipv4CidrBlock,
},
},
Local: &ibm.IsVpnGatewayConnectionLocalArgs{
Cidrs: pulumi.StringArray{
exampleIsSubnet.Ipv4CidrBlock,
},
},
})
if err != nil {
return err
}
return nil
})
}
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 example2 = new Ibm.IsSubnet("example2", new()
{
Vpc = exampleIsVpc.IsVpcId,
Zone = "us-south-2",
Ipv4CidrBlock = "10.240.68.0/24",
});
var exampleIsVpnGateway = new Ibm.IsVpnGateway("exampleIsVpnGateway", new()
{
Subnet = exampleIsSubnet.IsSubnetId,
Mode = "route",
});
var exampleIsVpnGatewayConnection = new Ibm.IsVpnGatewayConnection("exampleIsVpnGatewayConnection", new()
{
VpnGateway = exampleIsVpnGateway.IsVpnGatewayId,
PresharedKey = "VPNDemoPassword",
Peer = new Ibm.Inputs.IsVpnGatewayConnectionPeerArgs
{
Address = exampleIsVpnGateway.PublicIpAddress,
Cidrs = new[]
{
example2.Ipv4CidrBlock,
},
},
Local = new Ibm.Inputs.IsVpnGatewayConnectionLocalArgs
{
Cidrs = new[]
{
exampleIsSubnet.Ipv4CidrBlock,
},
},
});
});
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 com.pulumi.ibm.IsVpnGatewayConnection;
import com.pulumi.ibm.IsVpnGatewayConnectionArgs;
import com.pulumi.ibm.inputs.IsVpnGatewayConnectionPeerArgs;
import com.pulumi.ibm.inputs.IsVpnGatewayConnectionLocalArgs;
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 example2 = new IsSubnet("example2", IsSubnetArgs.builder()
.vpc(exampleIsVpc.isVpcId())
.zone("us-south-2")
.ipv4CidrBlock("10.240.68.0/24")
.build());
var exampleIsVpnGateway = new IsVpnGateway("exampleIsVpnGateway", IsVpnGatewayArgs.builder()
.subnet(exampleIsSubnet.isSubnetId())
.mode("route")
.build());
var exampleIsVpnGatewayConnection = new IsVpnGatewayConnection("exampleIsVpnGatewayConnection", IsVpnGatewayConnectionArgs.builder()
.vpnGateway(exampleIsVpnGateway.isVpnGatewayId())
.presharedKey("VPNDemoPassword")
.peer(IsVpnGatewayConnectionPeerArgs.builder()
.address(exampleIsVpnGateway.publicIpAddress())
.cidrs(example2.ipv4CidrBlock())
.build())
.local(IsVpnGatewayConnectionLocalArgs.builder()
.cidrs(exampleIsSubnet.ipv4CidrBlock())
.build())
.build());
}
}
resources:
exampleIsVpc:
type: ibm:IsVpc
exampleIsSubnet:
type: ibm:IsSubnet
properties:
vpc: ${exampleIsVpc.isVpcId}
zone: us-south-1
ipv4CidrBlock: 10.240.0.0/24
example2:
type: ibm:IsSubnet
properties:
vpc: ${exampleIsVpc.isVpcId}
zone: us-south-2
ipv4CidrBlock: 10.240.68.0/24
exampleIsVpnGateway:
type: ibm:IsVpnGateway
properties:
subnet: ${exampleIsSubnet.isSubnetId}
mode: route
exampleIsVpnGatewayConnection:
type: ibm:IsVpnGatewayConnection
properties:
vpnGateway: ${exampleIsVpnGateway.isVpnGatewayId}
presharedKey: VPNDemoPassword
peer:
address: ${exampleIsVpnGateway.publicIpAddress}
cidrs:
- ${example2.ipv4CidrBlock}
local:
cidrs:
- ${exampleIsSubnet.ipv4CidrBlock}
Policy Mode With An Active Peer VPN Gateway )
The following example creates a VPN gateway:
import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";
const exampleIsVpnGateway = new ibm.IsVpnGateway("exampleIsVpnGateway", {
subnet: ibm_is_subnet.example.id,
mode: "policy",
});
const exampleIsVpnGatewayConnection = new ibm.IsVpnGatewayConnection("exampleIsVpnGatewayConnection", {
vpnGateway: exampleIsVpnGateway.isVpnGatewayId,
presharedKey: "VPNDemoPassword",
local: {
cidrs: [ibm_is_subnet.example.ipv4_cidr_block],
},
peer: {
address: pulumi.all([exampleIsVpnGateway.publicIpAddress, exampleIsVpnGateway.publicIpAddress, exampleIsVpnGateway.publicIpAddress2]).apply(([exampleIsVpnGatewayPublicIpAddress, exampleIsVpnGatewayPublicIpAddress1, publicIpAddress2]) => exampleIsVpnGatewayPublicIpAddress != "0.0.0.0" ? exampleIsVpnGatewayPublicIpAddress1 : publicIpAddress2),
cidrs: [ibm_is_subnet.example2.ipv4_cidr_block],
},
});
import pulumi
import pulumi_ibm as ibm
example_is_vpn_gateway = ibm.IsVpnGateway("exampleIsVpnGateway",
subnet=ibm_is_subnet["example"]["id"],
mode="policy")
example_is_vpn_gateway_connection = ibm.IsVpnGatewayConnection("exampleIsVpnGatewayConnection",
vpn_gateway=example_is_vpn_gateway.is_vpn_gateway_id,
preshared_key="VPNDemoPassword",
local={
"cidrs": [ibm_is_subnet["example"]["ipv4_cidr_block"]],
},
peer={
"address": pulumi.Output.all(
exampleIsVpnGatewayPublic_ip_address=example_is_vpn_gateway.public_ip_address,
exampleIsVpnGatewayPublic_ip_address1=example_is_vpn_gateway.public_ip_address,
public_ip_address2=example_is_vpn_gateway.public_ip_address2
).apply(lambda resolved_outputs: resolved_outputs['exampleIsVpnGatewayPublic_ip_address1'] if resolved_outputs['exampleIsVpnGatewayPublic_ip_address'] != "0.0.0.0" else resolved_outputs['public_ip_address2'])
,
"cidrs": [ibm_is_subnet["example2"]["ipv4_cidr_block"]],
})
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 {
exampleIsVpnGateway, err := ibm.NewIsVpnGateway(ctx, "exampleIsVpnGateway", &ibm.IsVpnGatewayArgs{
Subnet: pulumi.Any(ibm_is_subnet.Example.Id),
Mode: pulumi.String("policy"),
})
if err != nil {
return err
}
var tmp0 string
if exampleIsVpnGatewayPublicIpAddress != "0.0.0.0" {
tmp0 = exampleIsVpnGatewayPublicIpAddress1
} else {
tmp0 = publicIpAddress2
}
_, err = ibm.NewIsVpnGatewayConnection(ctx, "exampleIsVpnGatewayConnection", &ibm.IsVpnGatewayConnectionArgs{
VpnGateway: exampleIsVpnGateway.IsVpnGatewayId,
PresharedKey: pulumi.String("VPNDemoPassword"),
Local: &ibm.IsVpnGatewayConnectionLocalArgs{
Cidrs: pulumi.StringArray{
ibm_is_subnet.Example.Ipv4_cidr_block,
},
},
Peer: &ibm.IsVpnGatewayConnectionPeerArgs{
Address: pulumi.All(exampleIsVpnGateway.PublicIpAddress, exampleIsVpnGateway.PublicIpAddress, exampleIsVpnGateway.PublicIpAddress2).ApplyT(func(_args []interface{}) (string, error) {
exampleIsVpnGatewayPublicIpAddress := _args[0].(string)
exampleIsVpnGatewayPublicIpAddress1 := _args[1].(string)
publicIpAddress2 := _args[2].(string)
return tmp0, nil
}).(pulumi.StringOutput),
Cidrs: pulumi.StringArray{
ibm_is_subnet.Example2.Ipv4_cidr_block,
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;
return await Deployment.RunAsync(() =>
{
var exampleIsVpnGateway = new Ibm.IsVpnGateway("exampleIsVpnGateway", new()
{
Subnet = ibm_is_subnet.Example.Id,
Mode = "policy",
});
var exampleIsVpnGatewayConnection = new Ibm.IsVpnGatewayConnection("exampleIsVpnGatewayConnection", new()
{
VpnGateway = exampleIsVpnGateway.IsVpnGatewayId,
PresharedKey = "VPNDemoPassword",
Local = new Ibm.Inputs.IsVpnGatewayConnectionLocalArgs
{
Cidrs = new[]
{
ibm_is_subnet.Example.Ipv4_cidr_block,
},
},
Peer = new Ibm.Inputs.IsVpnGatewayConnectionPeerArgs
{
Address = Output.Tuple(exampleIsVpnGateway.PublicIpAddress, exampleIsVpnGateway.PublicIpAddress, exampleIsVpnGateway.PublicIpAddress2).Apply(values =>
{
var exampleIsVpnGatewayPublicIpAddress = values.Item1;
var exampleIsVpnGatewayPublicIpAddress1 = values.Item2;
var publicIpAddress2 = values.Item3;
return exampleIsVpnGatewayPublicIpAddress != "0.0.0.0" ? exampleIsVpnGatewayPublicIpAddress1 : publicIpAddress2;
}),
Cidrs = new[]
{
ibm_is_subnet.Example2.Ipv4_cidr_block,
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IsVpnGateway;
import com.pulumi.ibm.IsVpnGatewayArgs;
import com.pulumi.ibm.IsVpnGatewayConnection;
import com.pulumi.ibm.IsVpnGatewayConnectionArgs;
import com.pulumi.ibm.inputs.IsVpnGatewayConnectionLocalArgs;
import com.pulumi.ibm.inputs.IsVpnGatewayConnectionPeerArgs;
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 exampleIsVpnGateway = new IsVpnGateway("exampleIsVpnGateway", IsVpnGatewayArgs.builder()
.subnet(ibm_is_subnet.example().id())
.mode("policy")
.build());
var exampleIsVpnGatewayConnection = new IsVpnGatewayConnection("exampleIsVpnGatewayConnection", IsVpnGatewayConnectionArgs.builder()
.vpnGateway(exampleIsVpnGateway.isVpnGatewayId())
.presharedKey("VPNDemoPassword")
.local(IsVpnGatewayConnectionLocalArgs.builder()
.cidrs(ibm_is_subnet.example().ipv4_cidr_block())
.build())
.peer(IsVpnGatewayConnectionPeerArgs.builder()
.address(Output.tuple(exampleIsVpnGateway.publicIpAddress(), exampleIsVpnGateway.publicIpAddress(), exampleIsVpnGateway.publicIpAddress2()).applyValue(values -> {
var exampleIsVpnGatewayPublicIpAddress = values.t1;
var exampleIsVpnGatewayPublicIpAddress1 = values.t2;
var publicIpAddress2 = values.t3;
return exampleIsVpnGatewayPublicIpAddress != "0.0.0.0" ? exampleIsVpnGatewayPublicIpAddress1 : publicIpAddress2;
}))
.cidrs(ibm_is_subnet.example2().ipv4_cidr_block())
.build())
.build());
}
}
Coming soon!
Create IsVpnGatewayConnection Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new IsVpnGatewayConnection(name: string, args: IsVpnGatewayConnectionArgs, opts?: CustomResourceOptions);
@overload
def IsVpnGatewayConnection(resource_name: str,
args: IsVpnGatewayConnectionArgs,
opts: Optional[ResourceOptions] = None)
@overload
def IsVpnGatewayConnection(resource_name: str,
opts: Optional[ResourceOptions] = None,
preshared_key: Optional[str] = None,
vpn_gateway: Optional[str] = None,
local: Optional[IsVpnGatewayConnectionLocalArgs] = None,
local_cidrs: Optional[Sequence[str]] = None,
ike_policy: Optional[str] = None,
interval: Optional[float] = None,
ipsec_policy: Optional[str] = None,
is_vpn_gateway_connection_id: Optional[str] = None,
action: Optional[str] = None,
establish_mode: Optional[str] = None,
name: Optional[str] = None,
peer: Optional[IsVpnGatewayConnectionPeerArgs] = None,
peer_address: Optional[str] = None,
peer_cidrs: Optional[Sequence[str]] = None,
distribute_traffic: Optional[bool] = None,
timeout: Optional[float] = None,
timeouts: Optional[IsVpnGatewayConnectionTimeoutsArgs] = None,
admin_state_up: Optional[bool] = None)
func NewIsVpnGatewayConnection(ctx *Context, name string, args IsVpnGatewayConnectionArgs, opts ...ResourceOption) (*IsVpnGatewayConnection, error)
public IsVpnGatewayConnection(string name, IsVpnGatewayConnectionArgs args, CustomResourceOptions? opts = null)
public IsVpnGatewayConnection(String name, IsVpnGatewayConnectionArgs args)
public IsVpnGatewayConnection(String name, IsVpnGatewayConnectionArgs args, CustomResourceOptions options)
type: ibm:IsVpnGatewayConnection
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args IsVpnGatewayConnectionArgs
- 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 IsVpnGatewayConnectionArgs
- 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 IsVpnGatewayConnectionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args IsVpnGatewayConnectionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args IsVpnGatewayConnectionArgs
- 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 isVpnGatewayConnectionResource = new Ibm.IsVpnGatewayConnection("isVpnGatewayConnectionResource", new()
{
PresharedKey = "string",
VpnGateway = "string",
Local = new Ibm.Inputs.IsVpnGatewayConnectionLocalArgs
{
Cidrs = new[]
{
"string",
},
IkeIdentities = new[]
{
new Ibm.Inputs.IsVpnGatewayConnectionLocalIkeIdentityArgs
{
Type = "string",
Value = "string",
},
},
},
IkePolicy = "string",
Interval = 0,
IpsecPolicy = "string",
IsVpnGatewayConnectionId = "string",
Action = "string",
EstablishMode = "string",
Name = "string",
Peer = new Ibm.Inputs.IsVpnGatewayConnectionPeerArgs
{
Address = "string",
Cidrs = new[]
{
"string",
},
Fqdn = "string",
IkeIdentity = new Ibm.Inputs.IsVpnGatewayConnectionPeerIkeIdentityArgs
{
Type = "string",
Value = "string",
},
Type = "string",
},
DistributeTraffic = false,
Timeout = 0,
Timeouts = new Ibm.Inputs.IsVpnGatewayConnectionTimeoutsArgs
{
Delete = "string",
},
AdminStateUp = false,
});
example, err := ibm.NewIsVpnGatewayConnection(ctx, "isVpnGatewayConnectionResource", &ibm.IsVpnGatewayConnectionArgs{
PresharedKey: pulumi.String("string"),
VpnGateway: pulumi.String("string"),
Local: &ibm.IsVpnGatewayConnectionLocalArgs{
Cidrs: pulumi.StringArray{
pulumi.String("string"),
},
IkeIdentities: ibm.IsVpnGatewayConnectionLocalIkeIdentityArray{
&ibm.IsVpnGatewayConnectionLocalIkeIdentityArgs{
Type: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
},
IkePolicy: pulumi.String("string"),
Interval: pulumi.Float64(0),
IpsecPolicy: pulumi.String("string"),
IsVpnGatewayConnectionId: pulumi.String("string"),
Action: pulumi.String("string"),
EstablishMode: pulumi.String("string"),
Name: pulumi.String("string"),
Peer: &ibm.IsVpnGatewayConnectionPeerArgs{
Address: pulumi.String("string"),
Cidrs: pulumi.StringArray{
pulumi.String("string"),
},
Fqdn: pulumi.String("string"),
IkeIdentity: &ibm.IsVpnGatewayConnectionPeerIkeIdentityArgs{
Type: pulumi.String("string"),
Value: pulumi.String("string"),
},
Type: pulumi.String("string"),
},
DistributeTraffic: pulumi.Bool(false),
Timeout: pulumi.Float64(0),
Timeouts: &ibm.IsVpnGatewayConnectionTimeoutsArgs{
Delete: pulumi.String("string"),
},
AdminStateUp: pulumi.Bool(false),
})
var isVpnGatewayConnectionResource = new IsVpnGatewayConnection("isVpnGatewayConnectionResource", IsVpnGatewayConnectionArgs.builder()
.presharedKey("string")
.vpnGateway("string")
.local(IsVpnGatewayConnectionLocalArgs.builder()
.cidrs("string")
.ikeIdentities(IsVpnGatewayConnectionLocalIkeIdentityArgs.builder()
.type("string")
.value("string")
.build())
.build())
.ikePolicy("string")
.interval(0)
.ipsecPolicy("string")
.isVpnGatewayConnectionId("string")
.action("string")
.establishMode("string")
.name("string")
.peer(IsVpnGatewayConnectionPeerArgs.builder()
.address("string")
.cidrs("string")
.fqdn("string")
.ikeIdentity(IsVpnGatewayConnectionPeerIkeIdentityArgs.builder()
.type("string")
.value("string")
.build())
.type("string")
.build())
.distributeTraffic(false)
.timeout(0)
.timeouts(IsVpnGatewayConnectionTimeoutsArgs.builder()
.delete("string")
.build())
.adminStateUp(false)
.build());
is_vpn_gateway_connection_resource = ibm.IsVpnGatewayConnection("isVpnGatewayConnectionResource",
preshared_key="string",
vpn_gateway="string",
local={
"cidrs": ["string"],
"ike_identities": [{
"type": "string",
"value": "string",
}],
},
ike_policy="string",
interval=0,
ipsec_policy="string",
is_vpn_gateway_connection_id="string",
action="string",
establish_mode="string",
name="string",
peer={
"address": "string",
"cidrs": ["string"],
"fqdn": "string",
"ike_identity": {
"type": "string",
"value": "string",
},
"type": "string",
},
distribute_traffic=False,
timeout=0,
timeouts={
"delete": "string",
},
admin_state_up=False)
const isVpnGatewayConnectionResource = new ibm.IsVpnGatewayConnection("isVpnGatewayConnectionResource", {
presharedKey: "string",
vpnGateway: "string",
local: {
cidrs: ["string"],
ikeIdentities: [{
type: "string",
value: "string",
}],
},
ikePolicy: "string",
interval: 0,
ipsecPolicy: "string",
isVpnGatewayConnectionId: "string",
action: "string",
establishMode: "string",
name: "string",
peer: {
address: "string",
cidrs: ["string"],
fqdn: "string",
ikeIdentity: {
type: "string",
value: "string",
},
type: "string",
},
distributeTraffic: false,
timeout: 0,
timeouts: {
"delete": "string",
},
adminStateUp: false,
});
type: ibm:IsVpnGatewayConnection
properties:
action: string
adminStateUp: false
distributeTraffic: false
establishMode: string
ikePolicy: string
interval: 0
ipsecPolicy: string
isVpnGatewayConnectionId: string
local:
cidrs:
- string
ikeIdentities:
- type: string
value: string
name: string
peer:
address: string
cidrs:
- string
fqdn: string
ikeIdentity:
type: string
value: string
type: string
presharedKey: string
timeout: 0
timeouts:
delete: string
vpnGateway: string
IsVpnGatewayConnection 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 IsVpnGatewayConnection resource accepts the following input properties:
- string
- The preshared key.
- Vpn
Gateway string - The unique identifier of the VPN gateway.
- Action string
- Dead peer detection actions. Supported values are restart, clear, hold, or none. Default value is
restart
. - Admin
State boolUp - The VPN gateway connection status. Default value is false. If set to false, the VPN gateway connection is shut down.
- Distribute
Traffic bool - Indicates whether the traffic is distributed between the
up
tunnels of the VPN gateway connection when the VPC route's next hop is a VPN connection. Iffalse
, the traffic is only routed through theup
tunnel with the lowerpublic_ip
address. Distributing traffic across tunnels of route-based VPN gateway connections. Traffic across tunnels can be distributed with a status of up in a route-based VPN gateway connection. When creating or updating a route-based VPN gateway connection, set the distribute_traffic property to true (default is false). Existing connections will have thedistribute_traffic
property set to false. - Establish
Mode string - The establish mode of the VPN gateway connection:-
bidirectional
: Either side of the VPN gateway can initiate IKE protocol negotiations or rekeying processes.-peer_only
: Only the peer can initiate IKE protocol negotiations for this VPN gateway connection. Additionally, the peer is responsible for initiating the rekeying process after the connection is established. If rekeying does not occur, the VPN gateway connection will be brought down after its lifetime expires. - Ike
Policy string - The ID of the IKE policy. Updating value from ID to
""
or making itnull
or removing it will remove the existing policy. - Interval double
- Dead peer detection interval in seconds. Default value is 2.
- Ipsec
Policy string - The ID of the IPSec policy. Updating value from ID to
""
or making itnull
or removing it will remove the existing policy. - Is
Vpn stringGateway Connection Id - (String) The unique identifier of the VPN gateway connection. The ID is composed of
<vpn_gateway_id>/<vpn_gateway_connection_id>
. - Local
Is
Vpn Gateway Connection Local - Nested schema for local:
- Local
Cidrs List<string> - List of local CIDRs for this resource.
local_cidrs
is deprecated and uselocal
block instead. - Name string
- The name of the VPN gateway connection.
- Peer
Is
Vpn Gateway Connection Peer - Nested schema for peer:
- Peer
Address string - The IP address of the peer VPN gateway.
peer_address
is deprecated and usepeer
block instead. - Peer
Cidrs List<string> - List of peer CIDRs for this resource.
peer_cidrs
is deprecated and usepeer
block instead. - Timeout double
- Dead peer detection timeout in seconds. Default value is 10.
- Timeouts
Is
Vpn Gateway Connection Timeouts
- string
- The preshared key.
- Vpn
Gateway string - The unique identifier of the VPN gateway.
- Action string
- Dead peer detection actions. Supported values are restart, clear, hold, or none. Default value is
restart
. - Admin
State boolUp - The VPN gateway connection status. Default value is false. If set to false, the VPN gateway connection is shut down.
- Distribute
Traffic bool - Indicates whether the traffic is distributed between the
up
tunnels of the VPN gateway connection when the VPC route's next hop is a VPN connection. Iffalse
, the traffic is only routed through theup
tunnel with the lowerpublic_ip
address. Distributing traffic across tunnels of route-based VPN gateway connections. Traffic across tunnels can be distributed with a status of up in a route-based VPN gateway connection. When creating or updating a route-based VPN gateway connection, set the distribute_traffic property to true (default is false). Existing connections will have thedistribute_traffic
property set to false. - Establish
Mode string - The establish mode of the VPN gateway connection:-
bidirectional
: Either side of the VPN gateway can initiate IKE protocol negotiations or rekeying processes.-peer_only
: Only the peer can initiate IKE protocol negotiations for this VPN gateway connection. Additionally, the peer is responsible for initiating the rekeying process after the connection is established. If rekeying does not occur, the VPN gateway connection will be brought down after its lifetime expires. - Ike
Policy string - The ID of the IKE policy. Updating value from ID to
""
or making itnull
or removing it will remove the existing policy. - Interval float64
- Dead peer detection interval in seconds. Default value is 2.
- Ipsec
Policy string - The ID of the IPSec policy. Updating value from ID to
""
or making itnull
or removing it will remove the existing policy. - Is
Vpn stringGateway Connection Id - (String) The unique identifier of the VPN gateway connection. The ID is composed of
<vpn_gateway_id>/<vpn_gateway_connection_id>
. - Local
Is
Vpn Gateway Connection Local Args - Nested schema for local:
- Local
Cidrs []string - List of local CIDRs for this resource.
local_cidrs
is deprecated and uselocal
block instead. - Name string
- The name of the VPN gateway connection.
- Peer
Is
Vpn Gateway Connection Peer Args - Nested schema for peer:
- Peer
Address string - The IP address of the peer VPN gateway.
peer_address
is deprecated and usepeer
block instead. - Peer
Cidrs []string - List of peer CIDRs for this resource.
peer_cidrs
is deprecated and usepeer
block instead. - Timeout float64
- Dead peer detection timeout in seconds. Default value is 10.
- Timeouts
Is
Vpn Gateway Connection Timeouts Args
- String
- The preshared key.
- vpn
Gateway String - The unique identifier of the VPN gateway.
- action String
- Dead peer detection actions. Supported values are restart, clear, hold, or none. Default value is
restart
. - admin
State BooleanUp - The VPN gateway connection status. Default value is false. If set to false, the VPN gateway connection is shut down.
- distribute
Traffic Boolean - Indicates whether the traffic is distributed between the
up
tunnels of the VPN gateway connection when the VPC route's next hop is a VPN connection. Iffalse
, the traffic is only routed through theup
tunnel with the lowerpublic_ip
address. Distributing traffic across tunnels of route-based VPN gateway connections. Traffic across tunnels can be distributed with a status of up in a route-based VPN gateway connection. When creating or updating a route-based VPN gateway connection, set the distribute_traffic property to true (default is false). Existing connections will have thedistribute_traffic
property set to false. - establish
Mode String - The establish mode of the VPN gateway connection:-
bidirectional
: Either side of the VPN gateway can initiate IKE protocol negotiations or rekeying processes.-peer_only
: Only the peer can initiate IKE protocol negotiations for this VPN gateway connection. Additionally, the peer is responsible for initiating the rekeying process after the connection is established. If rekeying does not occur, the VPN gateway connection will be brought down after its lifetime expires. - ike
Policy String - The ID of the IKE policy. Updating value from ID to
""
or making itnull
or removing it will remove the existing policy. - interval Double
- Dead peer detection interval in seconds. Default value is 2.
- ipsec
Policy String - The ID of the IPSec policy. Updating value from ID to
""
or making itnull
or removing it will remove the existing policy. - is
Vpn StringGateway Connection Id - (String) The unique identifier of the VPN gateway connection. The ID is composed of
<vpn_gateway_id>/<vpn_gateway_connection_id>
. - local
Is
Vpn Gateway Connection Local - Nested schema for local:
- local
Cidrs List<String> - List of local CIDRs for this resource.
local_cidrs
is deprecated and uselocal
block instead. - name String
- The name of the VPN gateway connection.
- peer
Is
Vpn Gateway Connection Peer - Nested schema for peer:
- peer
Address String - The IP address of the peer VPN gateway.
peer_address
is deprecated and usepeer
block instead. - peer
Cidrs List<String> - List of peer CIDRs for this resource.
peer_cidrs
is deprecated and usepeer
block instead. - timeout Double
- Dead peer detection timeout in seconds. Default value is 10.
- timeouts
Is
Vpn Gateway Connection Timeouts
- string
- The preshared key.
- vpn
Gateway string - The unique identifier of the VPN gateway.
- action string
- Dead peer detection actions. Supported values are restart, clear, hold, or none. Default value is
restart
. - admin
State booleanUp - The VPN gateway connection status. Default value is false. If set to false, the VPN gateway connection is shut down.
- distribute
Traffic boolean - Indicates whether the traffic is distributed between the
up
tunnels of the VPN gateway connection when the VPC route's next hop is a VPN connection. Iffalse
, the traffic is only routed through theup
tunnel with the lowerpublic_ip
address. Distributing traffic across tunnels of route-based VPN gateway connections. Traffic across tunnels can be distributed with a status of up in a route-based VPN gateway connection. When creating or updating a route-based VPN gateway connection, set the distribute_traffic property to true (default is false). Existing connections will have thedistribute_traffic
property set to false. - establish
Mode string - The establish mode of the VPN gateway connection:-
bidirectional
: Either side of the VPN gateway can initiate IKE protocol negotiations or rekeying processes.-peer_only
: Only the peer can initiate IKE protocol negotiations for this VPN gateway connection. Additionally, the peer is responsible for initiating the rekeying process after the connection is established. If rekeying does not occur, the VPN gateway connection will be brought down after its lifetime expires. - ike
Policy string - The ID of the IKE policy. Updating value from ID to
""
or making itnull
or removing it will remove the existing policy. - interval number
- Dead peer detection interval in seconds. Default value is 2.
- ipsec
Policy string - The ID of the IPSec policy. Updating value from ID to
""
or making itnull
or removing it will remove the existing policy. - is
Vpn stringGateway Connection Id - (String) The unique identifier of the VPN gateway connection. The ID is composed of
<vpn_gateway_id>/<vpn_gateway_connection_id>
. - local
Is
Vpn Gateway Connection Local - Nested schema for local:
- local
Cidrs string[] - List of local CIDRs for this resource.
local_cidrs
is deprecated and uselocal
block instead. - name string
- The name of the VPN gateway connection.
- peer
Is
Vpn Gateway Connection Peer - Nested schema for peer:
- peer
Address string - The IP address of the peer VPN gateway.
peer_address
is deprecated and usepeer
block instead. - peer
Cidrs string[] - List of peer CIDRs for this resource.
peer_cidrs
is deprecated and usepeer
block instead. - timeout number
- Dead peer detection timeout in seconds. Default value is 10.
- timeouts
Is
Vpn Gateway Connection Timeouts
- str
- The preshared key.
- vpn_
gateway str - The unique identifier of the VPN gateway.
- action str
- Dead peer detection actions. Supported values are restart, clear, hold, or none. Default value is
restart
. - admin_
state_ boolup - The VPN gateway connection status. Default value is false. If set to false, the VPN gateway connection is shut down.
- distribute_
traffic bool - Indicates whether the traffic is distributed between the
up
tunnels of the VPN gateway connection when the VPC route's next hop is a VPN connection. Iffalse
, the traffic is only routed through theup
tunnel with the lowerpublic_ip
address. Distributing traffic across tunnels of route-based VPN gateway connections. Traffic across tunnels can be distributed with a status of up in a route-based VPN gateway connection. When creating or updating a route-based VPN gateway connection, set the distribute_traffic property to true (default is false). Existing connections will have thedistribute_traffic
property set to false. - establish_
mode str - The establish mode of the VPN gateway connection:-
bidirectional
: Either side of the VPN gateway can initiate IKE protocol negotiations or rekeying processes.-peer_only
: Only the peer can initiate IKE protocol negotiations for this VPN gateway connection. Additionally, the peer is responsible for initiating the rekeying process after the connection is established. If rekeying does not occur, the VPN gateway connection will be brought down after its lifetime expires. - ike_
policy str - The ID of the IKE policy. Updating value from ID to
""
or making itnull
or removing it will remove the existing policy. - interval float
- Dead peer detection interval in seconds. Default value is 2.
- ipsec_
policy str - The ID of the IPSec policy. Updating value from ID to
""
or making itnull
or removing it will remove the existing policy. - is_
vpn_ strgateway_ connection_ id - (String) The unique identifier of the VPN gateway connection. The ID is composed of
<vpn_gateway_id>/<vpn_gateway_connection_id>
. - local
Is
Vpn Gateway Connection Local Args - Nested schema for local:
- local_
cidrs Sequence[str] - List of local CIDRs for this resource.
local_cidrs
is deprecated and uselocal
block instead. - name str
- The name of the VPN gateway connection.
- peer
Is
Vpn Gateway Connection Peer Args - Nested schema for peer:
- peer_
address str - The IP address of the peer VPN gateway.
peer_address
is deprecated and usepeer
block instead. - peer_
cidrs Sequence[str] - List of peer CIDRs for this resource.
peer_cidrs
is deprecated and usepeer
block instead. - timeout float
- Dead peer detection timeout in seconds. Default value is 10.
- timeouts
Is
Vpn Gateway Connection Timeouts Args
- String
- The preshared key.
- vpn
Gateway String - The unique identifier of the VPN gateway.
- action String
- Dead peer detection actions. Supported values are restart, clear, hold, or none. Default value is
restart
. - admin
State BooleanUp - The VPN gateway connection status. Default value is false. If set to false, the VPN gateway connection is shut down.
- distribute
Traffic Boolean - Indicates whether the traffic is distributed between the
up
tunnels of the VPN gateway connection when the VPC route's next hop is a VPN connection. Iffalse
, the traffic is only routed through theup
tunnel with the lowerpublic_ip
address. Distributing traffic across tunnels of route-based VPN gateway connections. Traffic across tunnels can be distributed with a status of up in a route-based VPN gateway connection. When creating or updating a route-based VPN gateway connection, set the distribute_traffic property to true (default is false). Existing connections will have thedistribute_traffic
property set to false. - establish
Mode String - The establish mode of the VPN gateway connection:-
bidirectional
: Either side of the VPN gateway can initiate IKE protocol negotiations or rekeying processes.-peer_only
: Only the peer can initiate IKE protocol negotiations for this VPN gateway connection. Additionally, the peer is responsible for initiating the rekeying process after the connection is established. If rekeying does not occur, the VPN gateway connection will be brought down after its lifetime expires. - ike
Policy String - The ID of the IKE policy. Updating value from ID to
""
or making itnull
or removing it will remove the existing policy. - interval Number
- Dead peer detection interval in seconds. Default value is 2.
- ipsec
Policy String - The ID of the IPSec policy. Updating value from ID to
""
or making itnull
or removing it will remove the existing policy. - is
Vpn StringGateway Connection Id - (String) The unique identifier of the VPN gateway connection. The ID is composed of
<vpn_gateway_id>/<vpn_gateway_connection_id>
. - local Property Map
- Nested schema for local:
- local
Cidrs List<String> - List of local CIDRs for this resource.
local_cidrs
is deprecated and uselocal
block instead. - name String
- The name of the VPN gateway connection.
- peer Property Map
- Nested schema for peer:
- peer
Address String - The IP address of the peer VPN gateway.
peer_address
is deprecated and usepeer
block instead. - peer
Cidrs List<String> - List of peer CIDRs for this resource.
peer_cidrs
is deprecated and usepeer
block instead. - timeout Number
- Dead peer detection timeout in seconds. Default value is 10.
- timeouts Property Map
Outputs
All input properties are implicitly available as output properties. Additionally, the IsVpnGatewayConnection resource produces the following output properties:
- Authentication
Mode string - (String) The authentication mode, only
psk
is supported. - Created
At string - (Timestamp) The date and time that VPN gateway connection was created.
- Gateway
Connection string - The unique identifier for this VPN gateway connection.
- Href string
- Href of the VPN Gateway connection
- Id string
- The provider-assigned unique ID for this managed resource.
- Mode string
- (String) The mode of the
VPN gateway
either policy or route. - string
- The crn of the VPN Gateway resource
- Resource
Type string - (String) The status of the VPN tunnel.
- Routing
Protocol string - Routing protocols for this VPN gateway connection.
- Status string
- (String) The status of a VPN gateway connection either
down
orup
. - Status
Reasons List<IsVpn Gateway Connection Status Reason> - (List) Array of reasons for the current status (if any).
- Tunnels
List<Is
Vpn Gateway Connection Tunnel> - (List) The VPN tunnel configuration for the VPN gateway connection (in static route mode).
- Authentication
Mode string - (String) The authentication mode, only
psk
is supported. - Created
At string - (Timestamp) The date and time that VPN gateway connection was created.
- Gateway
Connection string - The unique identifier for this VPN gateway connection.
- Href string
- Href of the VPN Gateway connection
- Id string
- The provider-assigned unique ID for this managed resource.
- Mode string
- (String) The mode of the
VPN gateway
either policy or route. - string
- The crn of the VPN Gateway resource
- Resource
Type string - (String) The status of the VPN tunnel.
- Routing
Protocol string - Routing protocols for this VPN gateway connection.
- Status string
- (String) The status of a VPN gateway connection either
down
orup
. - Status
Reasons []IsVpn Gateway Connection Status Reason - (List) Array of reasons for the current status (if any).
- Tunnels
[]Is
Vpn Gateway Connection Tunnel - (List) The VPN tunnel configuration for the VPN gateway connection (in static route mode).
- authentication
Mode String - (String) The authentication mode, only
psk
is supported. - created
At String - (Timestamp) The date and time that VPN gateway connection was created.
- gateway
Connection String - The unique identifier for this VPN gateway connection.
- href String
- Href of the VPN Gateway connection
- id String
- The provider-assigned unique ID for this managed resource.
- mode String
- (String) The mode of the
VPN gateway
either policy or route. - String
- The crn of the VPN Gateway resource
- resource
Type String - (String) The status of the VPN tunnel.
- routing
Protocol String - Routing protocols for this VPN gateway connection.
- status String
- (String) The status of a VPN gateway connection either
down
orup
. - status
Reasons List<IsVpn Gateway Connection Status Reason> - (List) Array of reasons for the current status (if any).
- tunnels
List<Is
Vpn Gateway Connection Tunnel> - (List) The VPN tunnel configuration for the VPN gateway connection (in static route mode).
- authentication
Mode string - (String) The authentication mode, only
psk
is supported. - created
At string - (Timestamp) The date and time that VPN gateway connection was created.
- gateway
Connection string - The unique identifier for this VPN gateway connection.
- href string
- Href of the VPN Gateway connection
- id string
- The provider-assigned unique ID for this managed resource.
- mode string
- (String) The mode of the
VPN gateway
either policy or route. - string
- The crn of the VPN Gateway resource
- resource
Type string - (String) The status of the VPN tunnel.
- routing
Protocol string - Routing protocols for this VPN gateway connection.
- status string
- (String) The status of a VPN gateway connection either
down
orup
. - status
Reasons IsVpn Gateway Connection Status Reason[] - (List) Array of reasons for the current status (if any).
- tunnels
Is
Vpn Gateway Connection Tunnel[] - (List) The VPN tunnel configuration for the VPN gateway connection (in static route mode).
- authentication_
mode str - (String) The authentication mode, only
psk
is supported. - created_
at str - (Timestamp) The date and time that VPN gateway connection was created.
- gateway_
connection str - The unique identifier for this VPN gateway connection.
- href str
- Href of the VPN Gateway connection
- id str
- The provider-assigned unique ID for this managed resource.
- mode str
- (String) The mode of the
VPN gateway
either policy or route. - str
- The crn of the VPN Gateway resource
- resource_
type str - (String) The status of the VPN tunnel.
- routing_
protocol str - Routing protocols for this VPN gateway connection.
- status str
- (String) The status of a VPN gateway connection either
down
orup
. - status_
reasons Sequence[IsVpn Gateway Connection Status Reason] - (List) Array of reasons for the current status (if any).
- tunnels
Sequence[Is
Vpn Gateway Connection Tunnel] - (List) The VPN tunnel configuration for the VPN gateway connection (in static route mode).
- authentication
Mode String - (String) The authentication mode, only
psk
is supported. - created
At String - (Timestamp) The date and time that VPN gateway connection was created.
- gateway
Connection String - The unique identifier for this VPN gateway connection.
- href String
- Href of the VPN Gateway connection
- id String
- The provider-assigned unique ID for this managed resource.
- mode String
- (String) The mode of the
VPN gateway
either policy or route. - String
- The crn of the VPN Gateway resource
- resource
Type String - (String) The status of the VPN tunnel.
- routing
Protocol String - Routing protocols for this VPN gateway connection.
- status String
- (String) The status of a VPN gateway connection either
down
orup
. - status
Reasons List<Property Map> - (List) Array of reasons for the current status (if any).
- tunnels List<Property Map>
- (List) The VPN tunnel configuration for the VPN gateway connection (in static route mode).
Look up Existing IsVpnGatewayConnection Resource
Get an existing IsVpnGatewayConnection 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?: IsVpnGatewayConnectionState, opts?: CustomResourceOptions): IsVpnGatewayConnection
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
action: Optional[str] = None,
admin_state_up: Optional[bool] = None,
authentication_mode: Optional[str] = None,
created_at: Optional[str] = None,
distribute_traffic: Optional[bool] = None,
establish_mode: Optional[str] = None,
gateway_connection: Optional[str] = None,
href: Optional[str] = None,
ike_policy: Optional[str] = None,
interval: Optional[float] = None,
ipsec_policy: Optional[str] = None,
is_vpn_gateway_connection_id: Optional[str] = None,
local: Optional[IsVpnGatewayConnectionLocalArgs] = None,
local_cidrs: Optional[Sequence[str]] = None,
mode: Optional[str] = None,
name: Optional[str] = None,
peer: Optional[IsVpnGatewayConnectionPeerArgs] = None,
peer_address: Optional[str] = None,
peer_cidrs: Optional[Sequence[str]] = None,
preshared_key: Optional[str] = None,
related_crn: Optional[str] = None,
resource_type: Optional[str] = None,
routing_protocol: Optional[str] = None,
status: Optional[str] = None,
status_reasons: Optional[Sequence[IsVpnGatewayConnectionStatusReasonArgs]] = None,
timeout: Optional[float] = None,
timeouts: Optional[IsVpnGatewayConnectionTimeoutsArgs] = None,
tunnels: Optional[Sequence[IsVpnGatewayConnectionTunnelArgs]] = None,
vpn_gateway: Optional[str] = None) -> IsVpnGatewayConnection
func GetIsVpnGatewayConnection(ctx *Context, name string, id IDInput, state *IsVpnGatewayConnectionState, opts ...ResourceOption) (*IsVpnGatewayConnection, error)
public static IsVpnGatewayConnection Get(string name, Input<string> id, IsVpnGatewayConnectionState? state, CustomResourceOptions? opts = null)
public static IsVpnGatewayConnection get(String name, Output<String> id, IsVpnGatewayConnectionState state, CustomResourceOptions options)
resources: _: type: ibm:IsVpnGatewayConnection get: 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.
- Action string
- Dead peer detection actions. Supported values are restart, clear, hold, or none. Default value is
restart
. - Admin
State boolUp - The VPN gateway connection status. Default value is false. If set to false, the VPN gateway connection is shut down.
- Authentication
Mode string - (String) The authentication mode, only
psk
is supported. - Created
At string - (Timestamp) The date and time that VPN gateway connection was created.
- Distribute
Traffic bool - Indicates whether the traffic is distributed between the
up
tunnels of the VPN gateway connection when the VPC route's next hop is a VPN connection. Iffalse
, the traffic is only routed through theup
tunnel with the lowerpublic_ip
address. Distributing traffic across tunnels of route-based VPN gateway connections. Traffic across tunnels can be distributed with a status of up in a route-based VPN gateway connection. When creating or updating a route-based VPN gateway connection, set the distribute_traffic property to true (default is false). Existing connections will have thedistribute_traffic
property set to false. - Establish
Mode string - The establish mode of the VPN gateway connection:-
bidirectional
: Either side of the VPN gateway can initiate IKE protocol negotiations or rekeying processes.-peer_only
: Only the peer can initiate IKE protocol negotiations for this VPN gateway connection. Additionally, the peer is responsible for initiating the rekeying process after the connection is established. If rekeying does not occur, the VPN gateway connection will be brought down after its lifetime expires. - Gateway
Connection string - The unique identifier for this VPN gateway connection.
- Href string
- Href of the VPN Gateway connection
- Ike
Policy string - The ID of the IKE policy. Updating value from ID to
""
or making itnull
or removing it will remove the existing policy. - Interval double
- Dead peer detection interval in seconds. Default value is 2.
- Ipsec
Policy string - The ID of the IPSec policy. Updating value from ID to
""
or making itnull
or removing it will remove the existing policy. - Is
Vpn stringGateway Connection Id - (String) The unique identifier of the VPN gateway connection. The ID is composed of
<vpn_gateway_id>/<vpn_gateway_connection_id>
. - Local
Is
Vpn Gateway Connection Local - Nested schema for local:
- Local
Cidrs List<string> - List of local CIDRs for this resource.
local_cidrs
is deprecated and uselocal
block instead. - Mode string
- (String) The mode of the
VPN gateway
either policy or route. - Name string
- The name of the VPN gateway connection.
- Peer
Is
Vpn Gateway Connection Peer - Nested schema for peer:
- Peer
Address string - The IP address of the peer VPN gateway.
peer_address
is deprecated and usepeer
block instead. - Peer
Cidrs List<string> - List of peer CIDRs for this resource.
peer_cidrs
is deprecated and usepeer
block instead. - string
- The preshared key.
- string
- The crn of the VPN Gateway resource
- Resource
Type string - (String) The status of the VPN tunnel.
- Routing
Protocol string - Routing protocols for this VPN gateway connection.
- Status string
- (String) The status of a VPN gateway connection either
down
orup
. - Status
Reasons List<IsVpn Gateway Connection Status Reason> - (List) Array of reasons for the current status (if any).
- Timeout double
- Dead peer detection timeout in seconds. Default value is 10.
- Timeouts
Is
Vpn Gateway Connection Timeouts - Tunnels
List<Is
Vpn Gateway Connection Tunnel> - (List) The VPN tunnel configuration for the VPN gateway connection (in static route mode).
- Vpn
Gateway string - The unique identifier of the VPN gateway.
- Action string
- Dead peer detection actions. Supported values are restart, clear, hold, or none. Default value is
restart
. - Admin
State boolUp - The VPN gateway connection status. Default value is false. If set to false, the VPN gateway connection is shut down.
- Authentication
Mode string - (String) The authentication mode, only
psk
is supported. - Created
At string - (Timestamp) The date and time that VPN gateway connection was created.
- Distribute
Traffic bool - Indicates whether the traffic is distributed between the
up
tunnels of the VPN gateway connection when the VPC route's next hop is a VPN connection. Iffalse
, the traffic is only routed through theup
tunnel with the lowerpublic_ip
address. Distributing traffic across tunnels of route-based VPN gateway connections. Traffic across tunnels can be distributed with a status of up in a route-based VPN gateway connection. When creating or updating a route-based VPN gateway connection, set the distribute_traffic property to true (default is false). Existing connections will have thedistribute_traffic
property set to false. - Establish
Mode string - The establish mode of the VPN gateway connection:-
bidirectional
: Either side of the VPN gateway can initiate IKE protocol negotiations or rekeying processes.-peer_only
: Only the peer can initiate IKE protocol negotiations for this VPN gateway connection. Additionally, the peer is responsible for initiating the rekeying process after the connection is established. If rekeying does not occur, the VPN gateway connection will be brought down after its lifetime expires. - Gateway
Connection string - The unique identifier for this VPN gateway connection.
- Href string
- Href of the VPN Gateway connection
- Ike
Policy string - The ID of the IKE policy. Updating value from ID to
""
or making itnull
or removing it will remove the existing policy. - Interval float64
- Dead peer detection interval in seconds. Default value is 2.
- Ipsec
Policy string - The ID of the IPSec policy. Updating value from ID to
""
or making itnull
or removing it will remove the existing policy. - Is
Vpn stringGateway Connection Id - (String) The unique identifier of the VPN gateway connection. The ID is composed of
<vpn_gateway_id>/<vpn_gateway_connection_id>
. - Local
Is
Vpn Gateway Connection Local Args - Nested schema for local:
- Local
Cidrs []string - List of local CIDRs for this resource.
local_cidrs
is deprecated and uselocal
block instead. - Mode string
- (String) The mode of the
VPN gateway
either policy or route. - Name string
- The name of the VPN gateway connection.
- Peer
Is
Vpn Gateway Connection Peer Args - Nested schema for peer:
- Peer
Address string - The IP address of the peer VPN gateway.
peer_address
is deprecated and usepeer
block instead. - Peer
Cidrs []string - List of peer CIDRs for this resource.
peer_cidrs
is deprecated and usepeer
block instead. - string
- The preshared key.
- string
- The crn of the VPN Gateway resource
- Resource
Type string - (String) The status of the VPN tunnel.
- Routing
Protocol string - Routing protocols for this VPN gateway connection.
- Status string
- (String) The status of a VPN gateway connection either
down
orup
. - Status
Reasons []IsVpn Gateway Connection Status Reason Args - (List) Array of reasons for the current status (if any).
- Timeout float64
- Dead peer detection timeout in seconds. Default value is 10.
- Timeouts
Is
Vpn Gateway Connection Timeouts Args - Tunnels
[]Is
Vpn Gateway Connection Tunnel Args - (List) The VPN tunnel configuration for the VPN gateway connection (in static route mode).
- Vpn
Gateway string - The unique identifier of the VPN gateway.
- action String
- Dead peer detection actions. Supported values are restart, clear, hold, or none. Default value is
restart
. - admin
State BooleanUp - The VPN gateway connection status. Default value is false. If set to false, the VPN gateway connection is shut down.
- authentication
Mode String - (String) The authentication mode, only
psk
is supported. - created
At String - (Timestamp) The date and time that VPN gateway connection was created.
- distribute
Traffic Boolean - Indicates whether the traffic is distributed between the
up
tunnels of the VPN gateway connection when the VPC route's next hop is a VPN connection. Iffalse
, the traffic is only routed through theup
tunnel with the lowerpublic_ip
address. Distributing traffic across tunnels of route-based VPN gateway connections. Traffic across tunnels can be distributed with a status of up in a route-based VPN gateway connection. When creating or updating a route-based VPN gateway connection, set the distribute_traffic property to true (default is false). Existing connections will have thedistribute_traffic
property set to false. - establish
Mode String - The establish mode of the VPN gateway connection:-
bidirectional
: Either side of the VPN gateway can initiate IKE protocol negotiations or rekeying processes.-peer_only
: Only the peer can initiate IKE protocol negotiations for this VPN gateway connection. Additionally, the peer is responsible for initiating the rekeying process after the connection is established. If rekeying does not occur, the VPN gateway connection will be brought down after its lifetime expires. - gateway
Connection String - The unique identifier for this VPN gateway connection.
- href String
- Href of the VPN Gateway connection
- ike
Policy String - The ID of the IKE policy. Updating value from ID to
""
or making itnull
or removing it will remove the existing policy. - interval Double
- Dead peer detection interval in seconds. Default value is 2.
- ipsec
Policy String - The ID of the IPSec policy. Updating value from ID to
""
or making itnull
or removing it will remove the existing policy. - is
Vpn StringGateway Connection Id - (String) The unique identifier of the VPN gateway connection. The ID is composed of
<vpn_gateway_id>/<vpn_gateway_connection_id>
. - local
Is
Vpn Gateway Connection Local - Nested schema for local:
- local
Cidrs List<String> - List of local CIDRs for this resource.
local_cidrs
is deprecated and uselocal
block instead. - mode String
- (String) The mode of the
VPN gateway
either policy or route. - name String
- The name of the VPN gateway connection.
- peer
Is
Vpn Gateway Connection Peer - Nested schema for peer:
- peer
Address String - The IP address of the peer VPN gateway.
peer_address
is deprecated and usepeer
block instead. - peer
Cidrs List<String> - List of peer CIDRs for this resource.
peer_cidrs
is deprecated and usepeer
block instead. - String
- The preshared key.
- String
- The crn of the VPN Gateway resource
- resource
Type String - (String) The status of the VPN tunnel.
- routing
Protocol String - Routing protocols for this VPN gateway connection.
- status String
- (String) The status of a VPN gateway connection either
down
orup
. - status
Reasons List<IsVpn Gateway Connection Status Reason> - (List) Array of reasons for the current status (if any).
- timeout Double
- Dead peer detection timeout in seconds. Default value is 10.
- timeouts
Is
Vpn Gateway Connection Timeouts - tunnels
List<Is
Vpn Gateway Connection Tunnel> - (List) The VPN tunnel configuration for the VPN gateway connection (in static route mode).
- vpn
Gateway String - The unique identifier of the VPN gateway.
- action string
- Dead peer detection actions. Supported values are restart, clear, hold, or none. Default value is
restart
. - admin
State booleanUp - The VPN gateway connection status. Default value is false. If set to false, the VPN gateway connection is shut down.
- authentication
Mode string - (String) The authentication mode, only
psk
is supported. - created
At string - (Timestamp) The date and time that VPN gateway connection was created.
- distribute
Traffic boolean - Indicates whether the traffic is distributed between the
up
tunnels of the VPN gateway connection when the VPC route's next hop is a VPN connection. Iffalse
, the traffic is only routed through theup
tunnel with the lowerpublic_ip
address. Distributing traffic across tunnels of route-based VPN gateway connections. Traffic across tunnels can be distributed with a status of up in a route-based VPN gateway connection. When creating or updating a route-based VPN gateway connection, set the distribute_traffic property to true (default is false). Existing connections will have thedistribute_traffic
property set to false. - establish
Mode string - The establish mode of the VPN gateway connection:-
bidirectional
: Either side of the VPN gateway can initiate IKE protocol negotiations or rekeying processes.-peer_only
: Only the peer can initiate IKE protocol negotiations for this VPN gateway connection. Additionally, the peer is responsible for initiating the rekeying process after the connection is established. If rekeying does not occur, the VPN gateway connection will be brought down after its lifetime expires. - gateway
Connection string - The unique identifier for this VPN gateway connection.
- href string
- Href of the VPN Gateway connection
- ike
Policy string - The ID of the IKE policy. Updating value from ID to
""
or making itnull
or removing it will remove the existing policy. - interval number
- Dead peer detection interval in seconds. Default value is 2.
- ipsec
Policy string - The ID of the IPSec policy. Updating value from ID to
""
or making itnull
or removing it will remove the existing policy. - is
Vpn stringGateway Connection Id - (String) The unique identifier of the VPN gateway connection. The ID is composed of
<vpn_gateway_id>/<vpn_gateway_connection_id>
. - local
Is
Vpn Gateway Connection Local - Nested schema for local:
- local
Cidrs string[] - List of local CIDRs for this resource.
local_cidrs
is deprecated and uselocal
block instead. - mode string
- (String) The mode of the
VPN gateway
either policy or route. - name string
- The name of the VPN gateway connection.
- peer
Is
Vpn Gateway Connection Peer - Nested schema for peer:
- peer
Address string - The IP address of the peer VPN gateway.
peer_address
is deprecated and usepeer
block instead. - peer
Cidrs string[] - List of peer CIDRs for this resource.
peer_cidrs
is deprecated and usepeer
block instead. - string
- The preshared key.
- string
- The crn of the VPN Gateway resource
- resource
Type string - (String) The status of the VPN tunnel.
- routing
Protocol string - Routing protocols for this VPN gateway connection.
- status string
- (String) The status of a VPN gateway connection either
down
orup
. - status
Reasons IsVpn Gateway Connection Status Reason[] - (List) Array of reasons for the current status (if any).
- timeout number
- Dead peer detection timeout in seconds. Default value is 10.
- timeouts
Is
Vpn Gateway Connection Timeouts - tunnels
Is
Vpn Gateway Connection Tunnel[] - (List) The VPN tunnel configuration for the VPN gateway connection (in static route mode).
- vpn
Gateway string - The unique identifier of the VPN gateway.
- action str
- Dead peer detection actions. Supported values are restart, clear, hold, or none. Default value is
restart
. - admin_
state_ boolup - The VPN gateway connection status. Default value is false. If set to false, the VPN gateway connection is shut down.
- authentication_
mode str - (String) The authentication mode, only
psk
is supported. - created_
at str - (Timestamp) The date and time that VPN gateway connection was created.
- distribute_
traffic bool - Indicates whether the traffic is distributed between the
up
tunnels of the VPN gateway connection when the VPC route's next hop is a VPN connection. Iffalse
, the traffic is only routed through theup
tunnel with the lowerpublic_ip
address. Distributing traffic across tunnels of route-based VPN gateway connections. Traffic across tunnels can be distributed with a status of up in a route-based VPN gateway connection. When creating or updating a route-based VPN gateway connection, set the distribute_traffic property to true (default is false). Existing connections will have thedistribute_traffic
property set to false. - establish_
mode str - The establish mode of the VPN gateway connection:-
bidirectional
: Either side of the VPN gateway can initiate IKE protocol negotiations or rekeying processes.-peer_only
: Only the peer can initiate IKE protocol negotiations for this VPN gateway connection. Additionally, the peer is responsible for initiating the rekeying process after the connection is established. If rekeying does not occur, the VPN gateway connection will be brought down after its lifetime expires. - gateway_
connection str - The unique identifier for this VPN gateway connection.
- href str
- Href of the VPN Gateway connection
- ike_
policy str - The ID of the IKE policy. Updating value from ID to
""
or making itnull
or removing it will remove the existing policy. - interval float
- Dead peer detection interval in seconds. Default value is 2.
- ipsec_
policy str - The ID of the IPSec policy. Updating value from ID to
""
or making itnull
or removing it will remove the existing policy. - is_
vpn_ strgateway_ connection_ id - (String) The unique identifier of the VPN gateway connection. The ID is composed of
<vpn_gateway_id>/<vpn_gateway_connection_id>
. - local
Is
Vpn Gateway Connection Local Args - Nested schema for local:
- local_
cidrs Sequence[str] - List of local CIDRs for this resource.
local_cidrs
is deprecated and uselocal
block instead. - mode str
- (String) The mode of the
VPN gateway
either policy or route. - name str
- The name of the VPN gateway connection.
- peer
Is
Vpn Gateway Connection Peer Args - Nested schema for peer:
- peer_
address str - The IP address of the peer VPN gateway.
peer_address
is deprecated and usepeer
block instead. - peer_
cidrs Sequence[str] - List of peer CIDRs for this resource.
peer_cidrs
is deprecated and usepeer
block instead. - str
- The preshared key.
- str
- The crn of the VPN Gateway resource
- resource_
type str - (String) The status of the VPN tunnel.
- routing_
protocol str - Routing protocols for this VPN gateway connection.
- status str
- (String) The status of a VPN gateway connection either
down
orup
. - status_
reasons Sequence[IsVpn Gateway Connection Status Reason Args] - (List) Array of reasons for the current status (if any).
- timeout float
- Dead peer detection timeout in seconds. Default value is 10.
- timeouts
Is
Vpn Gateway Connection Timeouts Args - tunnels
Sequence[Is
Vpn Gateway Connection Tunnel Args] - (List) The VPN tunnel configuration for the VPN gateway connection (in static route mode).
- vpn_
gateway str - The unique identifier of the VPN gateway.
- action String
- Dead peer detection actions. Supported values are restart, clear, hold, or none. Default value is
restart
. - admin
State BooleanUp - The VPN gateway connection status. Default value is false. If set to false, the VPN gateway connection is shut down.
- authentication
Mode String - (String) The authentication mode, only
psk
is supported. - created
At String - (Timestamp) The date and time that VPN gateway connection was created.
- distribute
Traffic Boolean - Indicates whether the traffic is distributed between the
up
tunnels of the VPN gateway connection when the VPC route's next hop is a VPN connection. Iffalse
, the traffic is only routed through theup
tunnel with the lowerpublic_ip
address. Distributing traffic across tunnels of route-based VPN gateway connections. Traffic across tunnels can be distributed with a status of up in a route-based VPN gateway connection. When creating or updating a route-based VPN gateway connection, set the distribute_traffic property to true (default is false). Existing connections will have thedistribute_traffic
property set to false. - establish
Mode String - The establish mode of the VPN gateway connection:-
bidirectional
: Either side of the VPN gateway can initiate IKE protocol negotiations or rekeying processes.-peer_only
: Only the peer can initiate IKE protocol negotiations for this VPN gateway connection. Additionally, the peer is responsible for initiating the rekeying process after the connection is established. If rekeying does not occur, the VPN gateway connection will be brought down after its lifetime expires. - gateway
Connection String - The unique identifier for this VPN gateway connection.
- href String
- Href of the VPN Gateway connection
- ike
Policy String - The ID of the IKE policy. Updating value from ID to
""
or making itnull
or removing it will remove the existing policy. - interval Number
- Dead peer detection interval in seconds. Default value is 2.
- ipsec
Policy String - The ID of the IPSec policy. Updating value from ID to
""
or making itnull
or removing it will remove the existing policy. - is
Vpn StringGateway Connection Id - (String) The unique identifier of the VPN gateway connection. The ID is composed of
<vpn_gateway_id>/<vpn_gateway_connection_id>
. - local Property Map
- Nested schema for local:
- local
Cidrs List<String> - List of local CIDRs for this resource.
local_cidrs
is deprecated and uselocal
block instead. - mode String
- (String) The mode of the
VPN gateway
either policy or route. - name String
- The name of the VPN gateway connection.
- peer Property Map
- Nested schema for peer:
- peer
Address String - The IP address of the peer VPN gateway.
peer_address
is deprecated and usepeer
block instead. - peer
Cidrs List<String> - List of peer CIDRs for this resource.
peer_cidrs
is deprecated and usepeer
block instead. - String
- The preshared key.
- String
- The crn of the VPN Gateway resource
- resource
Type String - (String) The status of the VPN tunnel.
- routing
Protocol String - Routing protocols for this VPN gateway connection.
- status String
- (String) The status of a VPN gateway connection either
down
orup
. - status
Reasons List<Property Map> - (List) Array of reasons for the current status (if any).
- timeout Number
- Dead peer detection timeout in seconds. Default value is 10.
- timeouts Property Map
- tunnels List<Property Map>
- (List) The VPN tunnel configuration for the VPN gateway connection (in static route mode).
- vpn
Gateway String - The unique identifier of the VPN gateway.
Supporting Types
IsVpnGatewayConnectionLocal, IsVpnGatewayConnectionLocalArgs
- Cidrs List<string>
- VPN gateway connection local CIDRs
- Ike
Identities List<IsVpn Gateway Connection Local Ike Identity> - The local IKE identities.A VPN gateway in static route mode consists of two members in active-active mode. The first identity applies to the first member, and the second identity applies to the second member. Nested schema for ike_identities:
- Cidrs []string
- VPN gateway connection local CIDRs
- Ike
Identities []IsVpn Gateway Connection Local Ike Identity - The local IKE identities.A VPN gateway in static route mode consists of two members in active-active mode. The first identity applies to the first member, and the second identity applies to the second member. Nested schema for ike_identities:
- cidrs List<String>
- VPN gateway connection local CIDRs
- ike
Identities List<IsVpn Gateway Connection Local Ike Identity> - The local IKE identities.A VPN gateway in static route mode consists of two members in active-active mode. The first identity applies to the first member, and the second identity applies to the second member. Nested schema for ike_identities:
- cidrs string[]
- VPN gateway connection local CIDRs
- ike
Identities IsVpn Gateway Connection Local Ike Identity[] - The local IKE identities.A VPN gateway in static route mode consists of two members in active-active mode. The first identity applies to the first member, and the second identity applies to the second member. Nested schema for ike_identities:
- cidrs Sequence[str]
- VPN gateway connection local CIDRs
- ike_
identities Sequence[IsVpn Gateway Connection Local Ike Identity] - The local IKE identities.A VPN gateway in static route mode consists of two members in active-active mode. The first identity applies to the first member, and the second identity applies to the second member. Nested schema for ike_identities:
- cidrs List<String>
- VPN gateway connection local CIDRs
- ike
Identities List<Property Map> - The local IKE identities.A VPN gateway in static route mode consists of two members in active-active mode. The first identity applies to the first member, and the second identity applies to the second member. Nested schema for ike_identities:
IsVpnGatewayConnectionLocalIkeIdentity, IsVpnGatewayConnectionLocalIkeIdentityArgs
- Type string
- The IKE identity type. [ fqdn, hostname, ipv4_address, key_id ] The enumerated values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the backup policy on which the unexpected property value was encountered.
- Value string
- The IKE identity FQDN value.
- Type string
- The IKE identity type. [ fqdn, hostname, ipv4_address, key_id ] The enumerated values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the backup policy on which the unexpected property value was encountered.
- Value string
- The IKE identity FQDN value.
- type String
- The IKE identity type. [ fqdn, hostname, ipv4_address, key_id ] The enumerated values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the backup policy on which the unexpected property value was encountered.
- value String
- The IKE identity FQDN value.
- type string
- The IKE identity type. [ fqdn, hostname, ipv4_address, key_id ] The enumerated values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the backup policy on which the unexpected property value was encountered.
- value string
- The IKE identity FQDN value.
- type str
- The IKE identity type. [ fqdn, hostname, ipv4_address, key_id ] The enumerated values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the backup policy on which the unexpected property value was encountered.
- value str
- The IKE identity FQDN value.
- type String
- The IKE identity type. [ fqdn, hostname, ipv4_address, key_id ] The enumerated values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the backup policy on which the unexpected property value was encountered.
- value String
- The IKE identity FQDN value.
IsVpnGatewayConnectionPeer, IsVpnGatewayConnectionPeerArgs
- Address string
- The IP address of the peer VPN gateway for this connection.
- Cidrs List<string>
- VPN gateway connection peer CIDRs
- Fqdn string
- The FQDN of the peer VPN gateway for this connection.
- Ike
Identity IsVpn Gateway Connection Peer Ike Identity - The peer IKE identity. Nested schema for ike_identity:
- Type string
- Indicates whether
peer.address
orpeer.fqdn
is used.
- Address string
- The IP address of the peer VPN gateway for this connection.
- Cidrs []string
- VPN gateway connection peer CIDRs
- Fqdn string
- The FQDN of the peer VPN gateway for this connection.
- Ike
Identity IsVpn Gateway Connection Peer Ike Identity - The peer IKE identity. Nested schema for ike_identity:
- Type string
- Indicates whether
peer.address
orpeer.fqdn
is used.
- address String
- The IP address of the peer VPN gateway for this connection.
- cidrs List<String>
- VPN gateway connection peer CIDRs
- fqdn String
- The FQDN of the peer VPN gateway for this connection.
- ike
Identity IsVpn Gateway Connection Peer Ike Identity - The peer IKE identity. Nested schema for ike_identity:
- type String
- Indicates whether
peer.address
orpeer.fqdn
is used.
- address string
- The IP address of the peer VPN gateway for this connection.
- cidrs string[]
- VPN gateway connection peer CIDRs
- fqdn string
- The FQDN of the peer VPN gateway for this connection.
- ike
Identity IsVpn Gateway Connection Peer Ike Identity - The peer IKE identity. Nested schema for ike_identity:
- type string
- Indicates whether
peer.address
orpeer.fqdn
is used.
- address str
- The IP address of the peer VPN gateway for this connection.
- cidrs Sequence[str]
- VPN gateway connection peer CIDRs
- fqdn str
- The FQDN of the peer VPN gateway for this connection.
- ike_
identity IsVpn Gateway Connection Peer Ike Identity - The peer IKE identity. Nested schema for ike_identity:
- type str
- Indicates whether
peer.address
orpeer.fqdn
is used.
- address String
- The IP address of the peer VPN gateway for this connection.
- cidrs List<String>
- VPN gateway connection peer CIDRs
- fqdn String
- The FQDN of the peer VPN gateway for this connection.
- ike
Identity Property Map - The peer IKE identity. Nested schema for ike_identity:
- type String
- Indicates whether
peer.address
orpeer.fqdn
is used.
IsVpnGatewayConnectionPeerIkeIdentity, IsVpnGatewayConnectionPeerIkeIdentityArgs
- Type string
- The IKE identity type. [ fqdn, hostname, ipv4_address, key_id ] The enumerated values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the backup policy on which the unexpected property value was encountered.
- Value string
- The IKE identity FQDN value.
- Type string
- The IKE identity type. [ fqdn, hostname, ipv4_address, key_id ] The enumerated values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the backup policy on which the unexpected property value was encountered.
- Value string
- The IKE identity FQDN value.
- type String
- The IKE identity type. [ fqdn, hostname, ipv4_address, key_id ] The enumerated values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the backup policy on which the unexpected property value was encountered.
- value String
- The IKE identity FQDN value.
- type string
- The IKE identity type. [ fqdn, hostname, ipv4_address, key_id ] The enumerated values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the backup policy on which the unexpected property value was encountered.
- value string
- The IKE identity FQDN value.
- type str
- The IKE identity type. [ fqdn, hostname, ipv4_address, key_id ] The enumerated values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the backup policy on which the unexpected property value was encountered.
- value str
- The IKE identity FQDN value.
- type String
- The IKE identity type. [ fqdn, hostname, ipv4_address, key_id ] The enumerated values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the backup policy on which the unexpected property value was encountered.
- value String
- The IKE identity FQDN value.
IsVpnGatewayConnectionStatusReason, IsVpnGatewayConnectionStatusReasonArgs
IsVpnGatewayConnectionTimeouts, IsVpnGatewayConnectionTimeoutsArgs
- Delete string
- Delete string
- delete String
- delete string
- delete str
- delete String
IsVpnGatewayConnectionTunnel, IsVpnGatewayConnectionTunnelArgs
Import
The ibm_is_vpn_gateway_connection
resource can be imported by using the VPN gateway ID and the VPN gateway connection ID.
Syntax
$ pulumi import ibm:index/isVpnGatewayConnection:IsVpnGatewayConnection example <vpn_gateway_ID>/<vpn_gateway_connection_ID>
Example
$ pulumi import ibm:index/isVpnGatewayConnection:IsVpnGatewayConnection example d7bec597-4726-451f-8a63-e62e6f19c32c/cea6651a-bc0a-4438-9f8a-a0770bbf3ebb
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.