UNPKG

@volcengine/pulumi

Version:

A Pulumi package for creating and managing volcengine cloud resources.

228 lines (227 loc) 8.11 kB
import * as pulumi from "@pulumi/pulumi"; /** * Provides a resource to manage transit router route entry * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as volcengine from "@volcengine/pulumi"; * * const fooCustomerGateway = new volcengine.vpn.CustomerGateway("fooCustomerGateway", { * ipAddress: "192.0.1.3", * customerGatewayName: "acc-test", * description: "acc-test", * }); * const fooConnection = new volcengine.vpn.Connection("fooConnection", { * vpnConnectionName: "acc-tf-test", * description: "acc-tf-test", * attachType: "TransitRouter", * 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, * logEnabled: false, * }); * const fooTransitRouter = new volcengine.transit_router.TransitRouter("fooTransitRouter", { * transitRouterName: "test-tf-acc", * description: "test-tf-acc", * }); * const fooVpnAttachment = new volcengine.transit_router.VpnAttachment("fooVpnAttachment", { * zoneId: "cn-beijing-a", * transitRouterAttachmentName: "tf-test-acc", * description: "tf-test-acc-desc", * transitRouterId: fooTransitRouter.id, * vpnConnectionId: fooConnection.id, * }); * const fooRouteTable = new volcengine.transit_router.RouteTable("fooRouteTable", { * description: "tf-test-acc-description-route-route-table", * transitRouterRouteTableName: "tf-table-test-acc", * transitRouterId: fooTransitRouter.id, * }); * const fooRouteEntry = new volcengine.transit_router.RouteEntry("fooRouteEntry", { * description: "tf-test-acc-description-entry", * transitRouterRouteEntryName: "tf-acc-test-entry", * destinationCidrBlock: "192.168.0.0/24", * transitRouterRouteEntryNextHopType: "Attachment", * transitRouterRouteTableId: fooRouteTable.transitRouterRouteTableId, * transitRouterRouteEntryNextHopId: fooVpnAttachment.transitRouterAttachmentId, * }); * ``` * * ## Import * * transit router route entry can be imported using the table and entry id, e.g. * * ```sh * $ pulumi import volcengine:transit_router/routeEntry:RouteEntry default tr-rtb-12b7qd3fmzf2817q7y2jkbd55:tr-rte-1i5i8khf9m58gae5kcx6*** * ``` */ 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 as path of the route entry. */ readonly asPath: pulumi.Output<string>; /** * The creation time of the route entry. */ readonly creationTime: pulumi.Output<string>; /** * Description of the transit router route entry. */ readonly description: pulumi.Output<string>; /** * The target network segment of the route entry. */ readonly destinationCidrBlock: pulumi.Output<string>; /** * The status of the route entry. */ readonly status: pulumi.Output<string>; /** * The id of the route entry. */ readonly transitRouterRouteEntryId: pulumi.Output<string>; /** * The name of the route entry. */ readonly transitRouterRouteEntryName: pulumi.Output<string>; /** * The next hot id of the routing entry. When the parameter TransitRouterRouteEntryNextHopType is Attachment, this parameter must be filled. */ readonly transitRouterRouteEntryNextHopId: pulumi.Output<string | undefined>; /** * The next hop type of the routing entry. The value can be Attachment or BlackHole. */ readonly transitRouterRouteEntryNextHopType: pulumi.Output<string>; /** * The type of the route entry. */ readonly transitRouterRouteEntryType: pulumi.Output<string>; /** * The id of the route table. */ readonly transitRouterRouteTableId: pulumi.Output<string>; /** * The update time of the route entry. */ readonly updateTime: 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 as path of the route entry. */ asPath?: pulumi.Input<string>; /** * The creation time of the route entry. */ creationTime?: pulumi.Input<string>; /** * Description of the transit router route entry. */ description?: pulumi.Input<string>; /** * The target network segment of the route entry. */ destinationCidrBlock?: pulumi.Input<string>; /** * The status of the route entry. */ status?: pulumi.Input<string>; /** * The id of the route entry. */ transitRouterRouteEntryId?: pulumi.Input<string>; /** * The name of the route entry. */ transitRouterRouteEntryName?: pulumi.Input<string>; /** * The next hot id of the routing entry. When the parameter TransitRouterRouteEntryNextHopType is Attachment, this parameter must be filled. */ transitRouterRouteEntryNextHopId?: pulumi.Input<string>; /** * The next hop type of the routing entry. The value can be Attachment or BlackHole. */ transitRouterRouteEntryNextHopType?: pulumi.Input<string>; /** * The type of the route entry. */ transitRouterRouteEntryType?: pulumi.Input<string>; /** * The id of the route table. */ transitRouterRouteTableId?: pulumi.Input<string>; /** * The update time of the route entry. */ updateTime?: pulumi.Input<string>; } /** * The set of arguments for constructing a RouteEntry resource. */ export interface RouteEntryArgs { /** * Description of the transit router route entry. */ description?: pulumi.Input<string>; /** * The target network segment of the route entry. */ destinationCidrBlock: pulumi.Input<string>; /** * The name of the route entry. */ transitRouterRouteEntryName?: pulumi.Input<string>; /** * The next hot id of the routing entry. When the parameter TransitRouterRouteEntryNextHopType is Attachment, this parameter must be filled. */ transitRouterRouteEntryNextHopId?: pulumi.Input<string>; /** * The next hop type of the routing entry. The value can be Attachment or BlackHole. */ transitRouterRouteEntryNextHopType: pulumi.Input<string>; /** * The id of the route table. */ transitRouterRouteTableId: pulumi.Input<string>; }