@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
178 lines (177 loc) • 5.79 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a resource to manage vpn gateway route
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* 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 fooCustomerGateway = new volcengine.vpn.CustomerGateway("fooCustomerGateway", {
* ipAddress: "192.0.1.3",
* customerGatewayName: "acc-test",
* description: "acc-test",
* projectName: "default",
* });
* const fooConnection = new volcengine.vpn.Connection("fooConnection", {
* vpnConnectionName: "acc-tf-test",
* description: "acc-tf-test",
* vpnGatewayId: fooGateway.id,
* customerGatewayId: fooCustomerGateway.id,
* localSubnets: ["192.168.0.0/22"],
* remoteSubnets: ["192.161.0.0/20"],
* dpdAction: "none",
* natTraversal: true,
* ikeConfigPsk: "acctest@!3",
* ikeConfigVersion: "ikev1",
* ikeConfigMode: "main",
* ikeConfigEncAlg: "aes",
* ikeConfigAuthAlg: "md5",
* ikeConfigDhGroup: "group2",
* ikeConfigLifetime: 9000,
* ikeConfigLocalId: "acc_test",
* ikeConfigRemoteId: "acc_test",
* ipsecConfigEncAlg: "aes",
* ipsecConfigAuthAlg: "sha256",
* ipsecConfigDhGroup: "group2",
* ipsecConfigLifetime: 9000,
* projectName: "default",
* logEnabled: false,
* });
* const fooGatewayRoute = new volcengine.vpn.GatewayRoute("fooGatewayRoute", {
* vpnGatewayId: fooGateway.id,
* destinationCidrBlock: "192.168.0.0/20",
* nextHopId: fooConnection.id,
* });
* ```
*
* ## Import
*
* VpnGatewayRoute can be imported using the id, e.g.
*
* ```sh
* $ pulumi import volcengine:vpn/gatewayRoute:GatewayRoute default vgr-3tex2c6c0v844c****
* ```
*/
export declare class GatewayRoute extends pulumi.CustomResource {
/**
* Get an existing GatewayRoute resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: GatewayRouteState, opts?: pulumi.CustomResourceOptions): GatewayRoute;
/**
* Returns true if the given object is an instance of GatewayRoute. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is GatewayRoute;
/**
* The create time of VPN gateway route.
*/
readonly creationTime: pulumi.Output<string>;
/**
* The destination cidr block of the VPN gateway route.
*/
readonly destinationCidrBlock: pulumi.Output<string>;
/**
* The next hop id of the VPN gateway route.
*/
readonly nextHopId: pulumi.Output<string>;
/**
* The status of the VPN gateway route.
*/
readonly status: pulumi.Output<string>;
/**
* The update time of VPN gateway route.
*/
readonly updateTime: pulumi.Output<string>;
/**
* The ID of the VPN gateway of the VPN gateway route.
*/
readonly vpnGatewayId: pulumi.Output<string>;
/**
* The ID of the VPN gateway route.
*/
readonly vpnGatewayRouteId: pulumi.Output<string>;
/**
* Create a GatewayRoute resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: GatewayRouteArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering GatewayRoute resources.
*/
export interface GatewayRouteState {
/**
* The create time of VPN gateway route.
*/
creationTime?: pulumi.Input<string>;
/**
* The destination cidr block of the VPN gateway route.
*/
destinationCidrBlock?: pulumi.Input<string>;
/**
* The next hop id of the VPN gateway route.
*/
nextHopId?: pulumi.Input<string>;
/**
* The status of the VPN gateway route.
*/
status?: pulumi.Input<string>;
/**
* The update time of VPN gateway route.
*/
updateTime?: pulumi.Input<string>;
/**
* The ID of the VPN gateway of the VPN gateway route.
*/
vpnGatewayId?: pulumi.Input<string>;
/**
* The ID of the VPN gateway route.
*/
vpnGatewayRouteId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a GatewayRoute resource.
*/
export interface GatewayRouteArgs {
/**
* The destination cidr block of the VPN gateway route.
*/
destinationCidrBlock: pulumi.Input<string>;
/**
* The next hop id of the VPN gateway route.
*/
nextHopId: pulumi.Input<string>;
/**
* The ID of the VPN gateway of the VPN gateway route.
*/
vpnGatewayId: pulumi.Input<string>;
}