@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
172 lines (171 loc) • 5.61 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a resource to manage route entry
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as volcengine from "@pulumi/volcengine";
* import * as volcengine from "@volcengine/pulumi";
*
* const fooZones = volcengine.ecs.getZones({});
* const fooVpc = new volcengine.vpc.Vpc("fooVpc", {
* vpcName: "acc-test-vpc-rn",
* cidrBlock: "172.16.0.0/16",
* });
* const fooSubnet = new volcengine.vpc.Subnet("fooSubnet", {
* subnetName: "acc-test-subnet-rn",
* cidrBlock: "172.16.0.0/24",
* zoneId: fooZones.then(fooZones => fooZones.zones?.[0]?.id),
* vpcId: fooVpc.id,
* });
* const fooGateway = new volcengine.nat.Gateway("fooGateway", {
* vpcId: fooVpc.id,
* subnetId: fooSubnet.id,
* spec: "Small",
* natGatewayName: "acc-test-nat-rn",
* });
* const fooRouteTable = new volcengine.vpc.RouteTable("fooRouteTable", {
* vpcId: fooVpc.id,
* routeTableName: "acc-test-route-table",
* });
* const fooRouteEntry = new volcengine.vpc.RouteEntry("fooRouteEntry", {
* routeTableId: fooRouteTable.id,
* destinationCidrBlock: "172.16.1.0/24",
* nextHopType: "NatGW",
* nextHopId: fooGateway.id,
* routeEntryName: "acc-test-route-entry",
* });
* ```
*
* ## Import
*
* Route entry can be imported using the route_table_id:route_entry_id, e.g.
*
* ```sh
* $ pulumi import volcengine:vpc/routeEntry:RouteEntry default vtb-274e19skkuhog7fap8u4i8ird:rte-274e1g9ei4k5c7fap8sp974fq
* ```
*/
export declare class RouteEntry extends pulumi.CustomResource {
/**
* Get an existing RouteEntry 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?: RouteEntryState, opts?: pulumi.CustomResourceOptions): RouteEntry;
/**
* Returns true if the given object is an instance of RouteEntry. 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 RouteEntry;
/**
* The description of the route entry.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The destination CIDR block of the route entry.
*/
readonly destinationCidrBlock: pulumi.Output<string>;
/**
* The id of the next hop.
*/
readonly nextHopId: pulumi.Output<string>;
/**
* The type of the next hop, Optional choice contains `Instance`, `HaVip`, `NetworkInterface`, `NatGW`, `VpnGW`, `TransitRouter`.
*/
readonly nextHopType: pulumi.Output<string>;
/**
* The id of the route entry.
*/
readonly routeEntryId: pulumi.Output<string>;
/**
* The name of the route entry.
*/
readonly routeEntryName: pulumi.Output<string | undefined>;
/**
* The id of the route table.
*/
readonly routeTableId: pulumi.Output<string>;
/**
* The description of the route entry.
*/
readonly status: pulumi.Output<string>;
/**
* Create a RouteEntry 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: RouteEntryArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering RouteEntry resources.
*/
export interface RouteEntryState {
/**
* The description of the route entry.
*/
description?: pulumi.Input<string>;
/**
* The destination CIDR block of the route entry.
*/
destinationCidrBlock?: pulumi.Input<string>;
/**
* The id of the next hop.
*/
nextHopId?: pulumi.Input<string>;
/**
* The type of the next hop, Optional choice contains `Instance`, `HaVip`, `NetworkInterface`, `NatGW`, `VpnGW`, `TransitRouter`.
*/
nextHopType?: pulumi.Input<string>;
/**
* The id of the route entry.
*/
routeEntryId?: pulumi.Input<string>;
/**
* The name of the route entry.
*/
routeEntryName?: pulumi.Input<string>;
/**
* The id of the route table.
*/
routeTableId?: pulumi.Input<string>;
/**
* The description of the route entry.
*/
status?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a RouteEntry resource.
*/
export interface RouteEntryArgs {
/**
* The description of the route entry.
*/
description?: pulumi.Input<string>;
/**
* The destination CIDR block of the route entry.
*/
destinationCidrBlock: pulumi.Input<string>;
/**
* The id of the next hop.
*/
nextHopId: pulumi.Input<string>;
/**
* The type of the next hop, Optional choice contains `Instance`, `HaVip`, `NetworkInterface`, `NatGW`, `VpnGW`, `TransitRouter`.
*/
nextHopType: pulumi.Input<string>;
/**
* The name of the route entry.
*/
routeEntryName?: pulumi.Input<string>;
/**
* The id of the route table.
*/
routeTableId: pulumi.Input<string>;
}