@pulumi/f5bigip
Version:
A Pulumi package for creating and managing F5 BigIP resources.
115 lines (114 loc) • 3.83 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* `f5bigip.net.Route` Manages a route configuration
*
* For resources should be named with their "full path". The full path is the combination of the partition + name of the resource. For example /Common/my-pool.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as f5bigip from "@pulumi/f5bigip";
*
* const route2 = new f5bigip.net.Route("route2", {
* name: "/Common/external-route",
* network: "10.10.10.0/24",
* gw: "1.1.1.2",
* });
* ```
*/
export declare class Route extends pulumi.CustomResource {
/**
* Get an existing Route 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?: RouteState, opts?: pulumi.CustomResourceOptions): Route;
/**
* Returns true if the given object is an instance of Route. 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 Route;
/**
* Specifies a gateway address for the route.
*/
readonly gw: pulumi.Output<string | undefined>;
/**
* Name of the route.Name of Route should be full path,full path is the combination of the `partition + route name`,For ex: `/Common/test-net-route`.
*/
readonly name: pulumi.Output<string>;
/**
* The destination subnet and netmask for the route.
*/
readonly network: pulumi.Output<string>;
/**
* reject route
*/
readonly reject: pulumi.Output<boolean | undefined>;
/**
* tunnel_ref to route traffic
*/
readonly tunnelRef: pulumi.Output<string | undefined>;
/**
* Create a Route 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: RouteArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Route resources.
*/
export interface RouteState {
/**
* Specifies a gateway address for the route.
*/
gw?: pulumi.Input<string>;
/**
* Name of the route.Name of Route should be full path,full path is the combination of the `partition + route name`,For ex: `/Common/test-net-route`.
*/
name?: pulumi.Input<string>;
/**
* The destination subnet and netmask for the route.
*/
network?: pulumi.Input<string>;
/**
* reject route
*/
reject?: pulumi.Input<boolean>;
/**
* tunnel_ref to route traffic
*/
tunnelRef?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Route resource.
*/
export interface RouteArgs {
/**
* Specifies a gateway address for the route.
*/
gw?: pulumi.Input<string>;
/**
* Name of the route.Name of Route should be full path,full path is the combination of the `partition + route name`,For ex: `/Common/test-net-route`.
*/
name: pulumi.Input<string>;
/**
* The destination subnet and netmask for the route.
*/
network: pulumi.Input<string>;
/**
* reject route
*/
reject?: pulumi.Input<boolean>;
/**
* tunnel_ref to route traffic
*/
tunnelRef?: pulumi.Input<string>;
}