@pulumi/openstack/networking/routerInterface.d.ts

A Pulumi package for creating and managing OpenStack cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Manages a V2 router interface resource within OpenStack.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as openstack from "@pulumi/openstack";
 *
 * const network1 = new openstack.networking.Network("network_1", {
 *     name: "tf_test_network",
 *     adminStateUp: true,
 * });
 * const subnet1 = new openstack.networking.Subnet("subnet_1", {
 *     networkId: network1.id,
 *     cidr: "192.168.199.0/24",
 *     ipVersion: 4,
 * });
 * const router1 = new openstack.networking.Router("router_1", {
 *     name: "my_router",
 *     externalNetworkId: "f67f0d72-0ddf-11e4-9d95-e1f29f417e2f",
 * });
 * const routerInterface1 = new openstack.networking.RouterInterface("router_interface_1", {
 *     routerId: router1.id,
 *     subnetId: subnet1.id,
 * });
 * ```
 *
 * ## Import
 *
 * Router Interfaces can be imported using the port `id`, e.g.
 *
 * $ openstack port list --router <router name or id>
 *
 * ```sh
 * $ pulumi import openstack:networking/routerInterface:RouterInterface int_1 port_id
 * ```
 */
export declare class RouterInterface extends pulumi.CustomResource {
    /**
     * Get an existing RouterInterface 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?: RouterInterfaceState, opts?: pulumi.CustomResourceOptions): RouterInterface;
    /**
     * Returns true if the given object is an instance of RouterInterface.  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 RouterInterface;
    /**
     * A boolean indicating whether the routes from the
     * corresponding router ID should be deleted so that the router interface can
     * be destroyed without any errors. The default value is `false`.
     */
    readonly forceDestroy: pulumi.Output<boolean | undefined>;
    /**
     * ID of the port this interface connects to. Changing
     * this creates a new router interface.
     */
    readonly portId: pulumi.Output<string>;
    /**
     * The region in which to obtain the V2 networking client.
     * A networking client is needed to create a router. If omitted, the
     * `region` argument of the provider is used. Changing this creates a new
     * router interface.
     */
    readonly region: pulumi.Output<string>;
    /**
     * ID of the router this interface belongs to. Changing
     * this creates a new router interface.
     */
    readonly routerId: pulumi.Output<string>;
    /**
     * ID of the subnet this interface connects to. Changing
     * this creates a new router interface.
     */
    readonly subnetId: pulumi.Output<string>;
    /**
     * Create a RouterInterface 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: RouterInterfaceArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering RouterInterface resources.
 */
export interface RouterInterfaceState {
    /**
     * A boolean indicating whether the routes from the
     * corresponding router ID should be deleted so that the router interface can
     * be destroyed without any errors. The default value is `false`.
     */
    forceDestroy?: pulumi.Input<boolean>;
    /**
     * ID of the port this interface connects to. Changing
     * this creates a new router interface.
     */
    portId?: pulumi.Input<string>;
    /**
     * The region in which to obtain the V2 networking client.
     * A networking client is needed to create a router. If omitted, the
     * `region` argument of the provider is used. Changing this creates a new
     * router interface.
     */
    region?: pulumi.Input<string>;
    /**
     * ID of the router this interface belongs to. Changing
     * this creates a new router interface.
     */
    routerId?: pulumi.Input<string>;
    /**
     * ID of the subnet this interface connects to. Changing
     * this creates a new router interface.
     */
    subnetId?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a RouterInterface resource.
 */
export interface RouterInterfaceArgs {
    /**
     * A boolean indicating whether the routes from the
     * corresponding router ID should be deleted so that the router interface can
     * be destroyed without any errors. The default value is `false`.
     */
    forceDestroy?: pulumi.Input<boolean>;
    /**
     * ID of the port this interface connects to. Changing
     * this creates a new router interface.
     */
    portId?: pulumi.Input<string>;
    /**
     * The region in which to obtain the V2 networking client.
     * A networking client is needed to create a router. If omitted, the
     * `region` argument of the provider is used. Changing this creates a new
     * router interface.
     */
    region?: pulumi.Input<string>;
    /**
     * ID of the router this interface belongs to. Changing
     * this creates a new router interface.
     */
    routerId: pulumi.Input<string>;
    /**
     * ID of the subnet this interface connects to. Changing
     * this creates a new router interface.
     */
    subnetId?: pulumi.Input<string>;
}