@pulumi/openstack
Version:
A Pulumi package for creating and managing OpenStack cloud resources.
140 lines (139 loc) • 5.11 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Creates a routing entry on a OpenStack V2 subnet.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as openstack from "@pulumi/openstack";
*
* const router1 = new openstack.networking.Router("router_1", {
* name: "router_1",
* adminStateUp: true,
* });
* const network1 = new openstack.networking.Network("network_1", {
* name: "network_1",
* adminStateUp: true,
* });
* const subnet1 = new openstack.networking.Subnet("subnet_1", {
* networkId: network1.id,
* cidr: "192.168.199.0/24",
* ipVersion: 4,
* });
* const subnetRoute1 = new openstack.networking.SubnetRoute("subnet_route_1", {
* subnetId: subnet1.id,
* destinationCidr: "10.0.1.0/24",
* nextHop: "192.168.199.254",
* });
* ```
*
* ## Import
*
* Routing entries can be imported using a combined ID using the following format: `<subnet_id>-route-<destination_cidr>-<next_hop>`
*
* ```sh
* $ pulumi import openstack:networking/subnetRoute:SubnetRoute subnet_route_1 686fe248-386c-4f70-9f6c-281607dad079-route-10.0.1.0/24-192.168.199.25
* ```
*/
export declare class SubnetRoute extends pulumi.CustomResource {
/**
* Get an existing SubnetRoute 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?: SubnetRouteState, opts?: pulumi.CustomResourceOptions): SubnetRoute;
/**
* Returns true if the given object is an instance of SubnetRoute. 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 SubnetRoute;
/**
* CIDR block to match on the packet’s destination IP. Changing
* this creates a new routing entry.
*/
readonly destinationCidr: pulumi.Output<string>;
/**
* IP address of the next hop gateway. Changing
* this creates a new routing entry.
*/
readonly nextHop: pulumi.Output<string>;
/**
* The region in which to obtain the V2 networking client.
* A networking client is needed to configure a routing entry on a subnet. If omitted, the
* `region` argument of the provider is used. Changing this creates a new
* routing entry.
*/
readonly region: pulumi.Output<string>;
/**
* ID of the subnet this routing entry belongs to. Changing
* this creates a new routing entry.
*/
readonly subnetId: pulumi.Output<string>;
/**
* Create a SubnetRoute 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: SubnetRouteArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering SubnetRoute resources.
*/
export interface SubnetRouteState {
/**
* CIDR block to match on the packet’s destination IP. Changing
* this creates a new routing entry.
*/
destinationCidr?: pulumi.Input<string>;
/**
* IP address of the next hop gateway. Changing
* this creates a new routing entry.
*/
nextHop?: pulumi.Input<string>;
/**
* The region in which to obtain the V2 networking client.
* A networking client is needed to configure a routing entry on a subnet. If omitted, the
* `region` argument of the provider is used. Changing this creates a new
* routing entry.
*/
region?: pulumi.Input<string>;
/**
* ID of the subnet this routing entry belongs to. Changing
* this creates a new routing entry.
*/
subnetId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a SubnetRoute resource.
*/
export interface SubnetRouteArgs {
/**
* CIDR block to match on the packet’s destination IP. Changing
* this creates a new routing entry.
*/
destinationCidr: pulumi.Input<string>;
/**
* IP address of the next hop gateway. Changing
* this creates a new routing entry.
*/
nextHop: pulumi.Input<string>;
/**
* The region in which to obtain the V2 networking client.
* A networking client is needed to configure a routing entry on a subnet. If omitted, the
* `region` argument of the provider is used. Changing this creates a new
* routing entry.
*/
region?: pulumi.Input<string>;
/**
* ID of the subnet this routing entry belongs to. Changing
* this creates a new routing entry.
*/
subnetId: pulumi.Input<string>;
}