Volcengine v0.0.24 published on Tuesday, Jun 25, 2024 by Volcengine
volcengine.vpn.Gateways
Explore with Pulumi AI
Use this data source to query detailed information of vpn gateways
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;
return await Deployment.RunAsync(() => 
{
    var fooVpc = new Volcengine.Vpc.Vpc("fooVpc", new()
    {
        VpcName = "acc-test-vpc",
        CidrBlock = "172.16.0.0/16",
    });
    var fooSubnet = new Volcengine.Vpc.Subnet("fooSubnet", new()
    {
        SubnetName = "acc-test-subnet",
        CidrBlock = "172.16.0.0/24",
        ZoneId = "cn-beijing-a",
        VpcId = fooVpc.Id,
    });
    var fooGateway = new Volcengine.Vpn.Gateway("fooGateway", new()
    {
        VpcId = fooVpc.Id,
        SubnetId = fooSubnet.Id,
        Bandwidth = 20,
        VpnGatewayName = "acc-test",
        Description = "acc-test",
        Period = 2,
        ProjectName = "default",
    });
    var fooGateways = Volcengine.Vpn.Gateways.Invoke(new()
    {
        Ids = new[]
        {
            fooGateway.Id,
        },
    });
});
package main
import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/vpc"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/vpn"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		fooVpc, err := vpc.NewVpc(ctx, "fooVpc", &vpc.VpcArgs{
			VpcName:   pulumi.String("acc-test-vpc"),
			CidrBlock: pulumi.String("172.16.0.0/16"),
		})
		if err != nil {
			return err
		}
		fooSubnet, err := vpc.NewSubnet(ctx, "fooSubnet", &vpc.SubnetArgs{
			SubnetName: pulumi.String("acc-test-subnet"),
			CidrBlock:  pulumi.String("172.16.0.0/24"),
			ZoneId:     pulumi.String("cn-beijing-a"),
			VpcId:      fooVpc.ID(),
		})
		if err != nil {
			return err
		}
		fooGateway, err := vpn.NewGateway(ctx, "fooGateway", &vpn.GatewayArgs{
			VpcId:          fooVpc.ID(),
			SubnetId:       fooSubnet.ID(),
			Bandwidth:      pulumi.Int(20),
			VpnGatewayName: pulumi.String("acc-test"),
			Description:    pulumi.String("acc-test"),
			Period:         pulumi.Int(2),
			ProjectName:    pulumi.String("default"),
		})
		if err != nil {
			return err
		}
		_ = vpn.GatewaysOutput(ctx, vpn.GatewaysOutputArgs{
			Ids: pulumi.StringArray{
				fooGateway.ID(),
			},
		}, nil)
		return nil
	})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.vpc.Vpc;
import com.pulumi.volcengine.vpc.VpcArgs;
import com.pulumi.volcengine.vpc.Subnet;
import com.pulumi.volcengine.vpc.SubnetArgs;
import com.pulumi.volcengine.vpn.Gateway;
import com.pulumi.volcengine.vpn.GatewayArgs;
import com.pulumi.volcengine.vpn.VpnFunctions;
import com.pulumi.volcengine.vpn.inputs.GatewaysArgs;
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 fooVpc = new Vpc("fooVpc", VpcArgs.builder()        
            .vpcName("acc-test-vpc")
            .cidrBlock("172.16.0.0/16")
            .build());
        var fooSubnet = new Subnet("fooSubnet", SubnetArgs.builder()        
            .subnetName("acc-test-subnet")
            .cidrBlock("172.16.0.0/24")
            .zoneId("cn-beijing-a")
            .vpcId(fooVpc.id())
            .build());
        var fooGateway = new Gateway("fooGateway", GatewayArgs.builder()        
            .vpcId(fooVpc.id())
            .subnetId(fooSubnet.id())
            .bandwidth(20)
            .vpnGatewayName("acc-test")
            .description("acc-test")
            .period(2)
            .projectName("default")
            .build());
        final var fooGateways = VpnFunctions.Gateways(GatewaysArgs.builder()
            .ids(fooGateway.id())
            .build());
    }
}
import pulumi
import pulumi_volcengine as volcengine
foo_vpc = volcengine.vpc.Vpc("fooVpc",
    vpc_name="acc-test-vpc",
    cidr_block="172.16.0.0/16")
foo_subnet = volcengine.vpc.Subnet("fooSubnet",
    subnet_name="acc-test-subnet",
    cidr_block="172.16.0.0/24",
    zone_id="cn-beijing-a",
    vpc_id=foo_vpc.id)
foo_gateway = volcengine.vpn.Gateway("fooGateway",
    vpc_id=foo_vpc.id,
    subnet_id=foo_subnet.id,
    bandwidth=20,
    vpn_gateway_name="acc-test",
    description="acc-test",
    period=2,
    project_name="default")
foo_gateways = volcengine.vpn.gateways_output(ids=[foo_gateway.id])
import * as pulumi from "@pulumi/pulumi";
import * as volcengine from "@pulumi/volcengine";
import * as volcengine from "@volcengine/pulumi";
const fooVpc = new volcengine.vpc.Vpc("fooVpc", {
    vpcName: "acc-test-vpc",
    cidrBlock: "172.16.0.0/16",
});
const fooSubnet = new volcengine.vpc.Subnet("fooSubnet", {
    subnetName: "acc-test-subnet",
    cidrBlock: "172.16.0.0/24",
    zoneId: "cn-beijing-a",
    vpcId: fooVpc.id,
});
const fooGateway = new volcengine.vpn.Gateway("fooGateway", {
    vpcId: fooVpc.id,
    subnetId: fooSubnet.id,
    bandwidth: 20,
    vpnGatewayName: "acc-test",
    description: "acc-test",
    period: 2,
    projectName: "default",
});
const fooGateways = volcengine.vpn.GatewaysOutput({
    ids: [fooGateway.id],
});
resources:
  fooVpc:
    type: volcengine:vpc:Vpc
    properties:
      vpcName: acc-test-vpc
      cidrBlock: 172.16.0.0/16
  fooSubnet:
    type: volcengine:vpc:Subnet
    properties:
      subnetName: acc-test-subnet
      cidrBlock: 172.16.0.0/24
      zoneId: cn-beijing-a
      vpcId: ${fooVpc.id}
  fooGateway:
    type: volcengine:vpn:Gateway
    properties:
      vpcId: ${fooVpc.id}
      subnetId: ${fooSubnet.id}
      bandwidth: 20
      vpnGatewayName: acc-test
      description: acc-test
      period: 2
      projectName: default
variables:
  fooGateways:
    fn::invoke:
      Function: volcengine:vpn:Gateways
      Arguments:
        ids:
          - ${fooGateway.id}
Using Gateways
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function gateways(args: GatewaysArgs, opts?: InvokeOptions): Promise<GatewaysResult>
function gatewaysOutput(args: GatewaysOutputArgs, opts?: InvokeOptions): Output<GatewaysResult>def gateways(ids: Optional[Sequence[str]] = None,
             ip_address: Optional[str] = None,
             name_regex: Optional[str] = None,
             output_file: Optional[str] = None,
             subnet_id: Optional[str] = None,
             tags: Optional[Sequence[GatewaysTag]] = None,
             vpc_id: Optional[str] = None,
             vpn_gateway_names: Optional[Sequence[str]] = None,
             opts: Optional[InvokeOptions] = None) -> GatewaysResult
def gateways_output(ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
             ip_address: Optional[pulumi.Input[str]] = None,
             name_regex: Optional[pulumi.Input[str]] = None,
             output_file: Optional[pulumi.Input[str]] = None,
             subnet_id: Optional[pulumi.Input[str]] = None,
             tags: Optional[pulumi.Input[Sequence[pulumi.Input[GatewaysTagArgs]]]] = None,
             vpc_id: Optional[pulumi.Input[str]] = None,
             vpn_gateway_names: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GatewaysResult]func Gateways(ctx *Context, args *GatewaysArgs, opts ...InvokeOption) (*GatewaysResult, error)
func GatewaysOutput(ctx *Context, args *GatewaysOutputArgs, opts ...InvokeOption) GatewaysResultOutputpublic static class Gateways 
{
    public static Task<GatewaysResult> InvokeAsync(GatewaysArgs args, InvokeOptions? opts = null)
    public static Output<GatewaysResult> Invoke(GatewaysInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GatewaysResult> gateways(GatewaysArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: volcengine:vpn:Gateways
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Ids List<string>
 - A list of VPN gateway ids.
 - Ip
Address string - A IP address of the VPN gateway.
 - Name
Regex string - A Name Regex of VPN gateway.
 - Output
File string - File name where to save data source results.
 - Subnet
Id string - A subnet ID of the VPN gateway.
 - 
List<Gateways
Tag>  - Tags.
 - Vpc
Id string - A VPC ID of the VPN gateway.
 - Vpn
Gateway List<string>Names  - A list of VPN gateway names.
 
- Ids []string
 - A list of VPN gateway ids.
 - Ip
Address string - A IP address of the VPN gateway.
 - Name
Regex string - A Name Regex of VPN gateway.
 - Output
File string - File name where to save data source results.
 - Subnet
Id string - A subnet ID of the VPN gateway.
 - 
[]Gateways
Tag  - Tags.
 - Vpc
Id string - A VPC ID of the VPN gateway.
 - Vpn
Gateway []stringNames  - A list of VPN gateway names.
 
- ids List<String>
 - A list of VPN gateway ids.
 - ip
Address String - A IP address of the VPN gateway.
 - name
Regex String - A Name Regex of VPN gateway.
 - output
File String - File name where to save data source results.
 - subnet
Id String - A subnet ID of the VPN gateway.
 - 
List<Gateways
Tag>  - Tags.
 - vpc
Id String - A VPC ID of the VPN gateway.
 - vpn
Gateway List<String>Names  - A list of VPN gateway names.
 
- ids string[]
 - A list of VPN gateway ids.
 - ip
Address string - A IP address of the VPN gateway.
 - name
Regex string - A Name Regex of VPN gateway.
 - output
File string - File name where to save data source results.
 - subnet
Id string - A subnet ID of the VPN gateway.
 - 
Gateways
Tag[]  - Tags.
 - vpc
Id string - A VPC ID of the VPN gateway.
 - vpn
Gateway string[]Names  - A list of VPN gateway names.
 
- ids Sequence[str]
 - A list of VPN gateway ids.
 - ip_
address str - A IP address of the VPN gateway.
 - name_
regex str - A Name Regex of VPN gateway.
 - output_
file str - File name where to save data source results.
 - subnet_
id str - A subnet ID of the VPN gateway.
 - 
Sequence[Gateways
Tag]  - Tags.
 - vpc_
id str - A VPC ID of the VPN gateway.
 - vpn_
gateway_ Sequence[str]names  - A list of VPN gateway names.
 
- ids List<String>
 - A list of VPN gateway ids.
 - ip
Address String - A IP address of the VPN gateway.
 - name
Regex String - A Name Regex of VPN gateway.
 - output
File String - File name where to save data source results.
 - subnet
Id String - A subnet ID of the VPN gateway.
 - List<Property Map>
 - Tags.
 - vpc
Id String - A VPC ID of the VPN gateway.
 - vpn
Gateway List<String>Names  - A list of VPN gateway names.
 
Gateways Result
The following output properties are available:
- Id string
 - The provider-assigned unique ID for this managed resource.
 - Total
Count int - The total count of VPN gateway query.
 - Vpn
Gateways List<GatewaysVpn Gateway>  - The collection of VPN gateway query.
 - Ids List<string>
 - Ip
Address string - The IP address of the VPN gateway.
 - Name
Regex string - Output
File string - Subnet
Id string - 
List<Gateways
Tag>  - Tags.
 - Vpc
Id string - The VPC ID of the VPN gateway.
 - Vpn
Gateway List<string>Names  
- Id string
 - The provider-assigned unique ID for this managed resource.
 - Total
Count int - The total count of VPN gateway query.
 - Vpn
Gateways []GatewaysVpn Gateway  - The collection of VPN gateway query.
 - Ids []string
 - Ip
Address string - The IP address of the VPN gateway.
 - Name
Regex string - Output
File string - Subnet
Id string - 
[]Gateways
Tag  - Tags.
 - Vpc
Id string - The VPC ID of the VPN gateway.
 - Vpn
Gateway []stringNames  
- id String
 - The provider-assigned unique ID for this managed resource.
 - total
Count Integer - The total count of VPN gateway query.
 - vpn
Gateways List<GatewaysVpn Gateway>  - The collection of VPN gateway query.
 - ids List<String>
 - ip
Address String - The IP address of the VPN gateway.
 - name
Regex String - output
File String - subnet
Id String - 
List<Gateways
Tag>  - Tags.
 - vpc
Id String - The VPC ID of the VPN gateway.
 - vpn
Gateway List<String>Names  
- id string
 - The provider-assigned unique ID for this managed resource.
 - total
Count number - The total count of VPN gateway query.
 - vpn
Gateways GatewaysVpn Gateway[]  - The collection of VPN gateway query.
 - ids string[]
 - ip
Address string - The IP address of the VPN gateway.
 - name
Regex string - output
File string - subnet
Id string - 
Gateways
Tag[]  - Tags.
 - vpc
Id string - The VPC ID of the VPN gateway.
 - vpn
Gateway string[]Names  
- id str
 - The provider-assigned unique ID for this managed resource.
 - total_
count int - The total count of VPN gateway query.
 - vpn_
gateways Sequence[GatewaysVpn Gateway]  - The collection of VPN gateway query.
 - ids Sequence[str]
 - ip_
address str - The IP address of the VPN gateway.
 - name_
regex str - output_
file str - subnet_
id str - 
Sequence[Gateways
Tag]  - Tags.
 - vpc_
id str - The VPC ID of the VPN gateway.
 - vpn_
gateway_ Sequence[str]names  
- id String
 - The provider-assigned unique ID for this managed resource.
 - total
Count Number - The total count of VPN gateway query.
 - vpn
Gateways List<Property Map> - The collection of VPN gateway query.
 - ids List<String>
 - ip
Address String - The IP address of the VPN gateway.
 - name
Regex String - output
File String - subnet
Id String - List<Property Map>
 - Tags.
 - vpc
Id String - The VPC ID of the VPN gateway.
 - vpn
Gateway List<String>Names  
Supporting Types
GatewaysTag 
GatewaysVpnGateway  
- Account
Id string - The account ID of the VPN gateway.
 - Bandwidth int
 - The bandwidth of the VPN gateway.
 - Billing
Type string - The BillingType of the VPN gateway.
 - Business
Status string - The business status of the VPN gateway.
 - Connection
Count int - The connection count of the VPN gateway.
 - Creation
Time string - The create time of VPN gateway.
 - Deleted
Time string - The deleted time of the VPN gateway.
 - Description string
 - The description of the VPN gateway.
 - Expired
Time string - The expired time of the VPN gateway.
 - Id string
 - The ID of the VPN gateway.
 - Ip
Address string - A IP address of the VPN gateway.
 - Ipsec
Enabled bool - Whether ipsec is enabled.
 - Lock
Reason string - The lock reason of the VPN gateway.
 - Project
Name string - The name of project.
 - Route
Count int - The route count of the VPN gateway.
 - Ssl
Enabled bool - Whether ssl is enabled.
 - Ssl
Max intConnections  - The max connections of ssl.
 - Status string
 - The status of the VPN gateway.
 - 
List<Gateways
Vpn Gateway Tag>  - Tags.
 - Update
Time string - The update time of VPN gateway.
 - Vpc
Id string - A VPC ID of the VPN gateway.
 - Vpn
Gateway stringId  - The ID of the VPN gateway.
 - Vpn
Gateway stringName  - The name of the VPN gateway.
 - Subnet
Id string - A subnet ID of the VPN gateway.
 
- Account
Id string - The account ID of the VPN gateway.
 - Bandwidth int
 - The bandwidth of the VPN gateway.
 - Billing
Type string - The BillingType of the VPN gateway.
 - Business
Status string - The business status of the VPN gateway.
 - Connection
Count int - The connection count of the VPN gateway.
 - Creation
Time string - The create time of VPN gateway.
 - Deleted
Time string - The deleted time of the VPN gateway.
 - Description string
 - The description of the VPN gateway.
 - Expired
Time string - The expired time of the VPN gateway.
 - Id string
 - The ID of the VPN gateway.
 - Ip
Address string - A IP address of the VPN gateway.
 - Ipsec
Enabled bool - Whether ipsec is enabled.
 - Lock
Reason string - The lock reason of the VPN gateway.
 - Project
Name string - The name of project.
 - Route
Count int - The route count of the VPN gateway.
 - Ssl
Enabled bool - Whether ssl is enabled.
 - Ssl
Max intConnections  - The max connections of ssl.
 - Status string
 - The status of the VPN gateway.
 - 
[]Gateways
Vpn Gateway Tag  - Tags.
 - Update
Time string - The update time of VPN gateway.
 - Vpc
Id string - A VPC ID of the VPN gateway.
 - Vpn
Gateway stringId  - The ID of the VPN gateway.
 - Vpn
Gateway stringName  - The name of the VPN gateway.
 - Subnet
Id string - A subnet ID of the VPN gateway.
 
- account
Id String - The account ID of the VPN gateway.
 - bandwidth Integer
 - The bandwidth of the VPN gateway.
 - billing
Type String - The BillingType of the VPN gateway.
 - business
Status String - The business status of the VPN gateway.
 - connection
Count Integer - The connection count of the VPN gateway.
 - creation
Time String - The create time of VPN gateway.
 - deleted
Time String - The deleted time of the VPN gateway.
 - description String
 - The description of the VPN gateway.
 - expired
Time String - The expired time of the VPN gateway.
 - id String
 - The ID of the VPN gateway.
 - ip
Address String - A IP address of the VPN gateway.
 - ipsec
Enabled Boolean - Whether ipsec is enabled.
 - lock
Reason String - The lock reason of the VPN gateway.
 - project
Name String - The name of project.
 - route
Count Integer - The route count of the VPN gateway.
 - ssl
Enabled Boolean - Whether ssl is enabled.
 - ssl
Max IntegerConnections  - The max connections of ssl.
 - status String
 - The status of the VPN gateway.
 - 
List<Gateways
Vpn Gateway Tag>  - Tags.
 - update
Time String - The update time of VPN gateway.
 - vpc
Id String - A VPC ID of the VPN gateway.
 - vpn
Gateway StringId  - The ID of the VPN gateway.
 - vpn
Gateway StringName  - The name of the VPN gateway.
 - subnet
Id String - A subnet ID of the VPN gateway.
 
- account
Id string - The account ID of the VPN gateway.
 - bandwidth number
 - The bandwidth of the VPN gateway.
 - billing
Type string - The BillingType of the VPN gateway.
 - business
Status string - The business status of the VPN gateway.
 - connection
Count number - The connection count of the VPN gateway.
 - creation
Time string - The create time of VPN gateway.
 - deleted
Time string - The deleted time of the VPN gateway.
 - description string
 - The description of the VPN gateway.
 - expired
Time string - The expired time of the VPN gateway.
 - id string
 - The ID of the VPN gateway.
 - ip
Address string - A IP address of the VPN gateway.
 - ipsec
Enabled boolean - Whether ipsec is enabled.
 - lock
Reason string - The lock reason of the VPN gateway.
 - project
Name string - The name of project.
 - route
Count number - The route count of the VPN gateway.
 - ssl
Enabled boolean - Whether ssl is enabled.
 - ssl
Max numberConnections  - The max connections of ssl.
 - status string
 - The status of the VPN gateway.
 - 
Gateways
Vpn Gateway Tag[]  - Tags.
 - update
Time string - The update time of VPN gateway.
 - vpc
Id string - A VPC ID of the VPN gateway.
 - vpn
Gateway stringId  - The ID of the VPN gateway.
 - vpn
Gateway stringName  - The name of the VPN gateway.
 - subnet
Id string - A subnet ID of the VPN gateway.
 
- account_
id str - The account ID of the VPN gateway.
 - bandwidth int
 - The bandwidth of the VPN gateway.
 - billing_
type str - The BillingType of the VPN gateway.
 - business_
status str - The business status of the VPN gateway.
 - connection_
count int - The connection count of the VPN gateway.
 - creation_
time str - The create time of VPN gateway.
 - deleted_
time str - The deleted time of the VPN gateway.
 - description str
 - The description of the VPN gateway.
 - expired_
time str - The expired time of the VPN gateway.
 - id str
 - The ID of the VPN gateway.
 - ip_
address str - A IP address of the VPN gateway.
 - ipsec_
enabled bool - Whether ipsec is enabled.
 - lock_
reason str - The lock reason of the VPN gateway.
 - project_
name str - The name of project.
 - route_
count int - The route count of the VPN gateway.
 - ssl_
enabled bool - Whether ssl is enabled.
 - ssl_
max_ intconnections  - The max connections of ssl.
 - status str
 - The status of the VPN gateway.
 - 
Sequence[Gateways
Vpn Gateway Tag]  - Tags.
 - update_
time str - The update time of VPN gateway.
 - vpc_
id str - A VPC ID of the VPN gateway.
 - vpn_
gateway_ strid  - The ID of the VPN gateway.
 - vpn_
gateway_ strname  - The name of the VPN gateway.
 - subnet_
id str - A subnet ID of the VPN gateway.
 
- account
Id String - The account ID of the VPN gateway.
 - bandwidth Number
 - The bandwidth of the VPN gateway.
 - billing
Type String - The BillingType of the VPN gateway.
 - business
Status String - The business status of the VPN gateway.
 - connection
Count Number - The connection count of the VPN gateway.
 - creation
Time String - The create time of VPN gateway.
 - deleted
Time String - The deleted time of the VPN gateway.
 - description String
 - The description of the VPN gateway.
 - expired
Time String - The expired time of the VPN gateway.
 - id String
 - The ID of the VPN gateway.
 - ip
Address String - A IP address of the VPN gateway.
 - ipsec
Enabled Boolean - Whether ipsec is enabled.
 - lock
Reason String - The lock reason of the VPN gateway.
 - project
Name String - The name of project.
 - route
Count Number - The route count of the VPN gateway.
 - ssl
Enabled Boolean - Whether ssl is enabled.
 - ssl
Max NumberConnections  - The max connections of ssl.
 - status String
 - The status of the VPN gateway.
 - List<Property Map>
 - Tags.
 - update
Time String - The update time of VPN gateway.
 - vpc
Id String - A VPC ID of the VPN gateway.
 - vpn
Gateway StringId  - The ID of the VPN gateway.
 - vpn
Gateway StringName  - The name of the VPN gateway.
 - subnet
Id String - A subnet ID of the VPN gateway.
 
GatewaysVpnGatewayTag   
Package Details
- Repository
 - volcengine volcengine/pulumi-volcengine
 - License
 - Apache-2.0
 - Notes
 - This Pulumi package is based on the 
volcengineTerraform Provider.