@pulumi/openstack
Version:
A Pulumi package for creating and managing OpenStack cloud resources.
117 lines (116 loc) • 4.71 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Associates a floating IP to a port. This is useful for situations
* where you have a pre-allocated floating IP or are unable to use the
* `openstack.networking.FloatingIp` resource to create a floating IP.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as openstack from "@pulumi/openstack";
*
* const port1 = new openstack.networking.Port("port_1", {networkId: "a5bbd213-e1d3-49b6-aed1-9df60ea94b9a"});
* const fip1 = new openstack.networking.FloatingIpAssociate("fip_1", {
* floatingIp: "1.2.3.4",
* portId: port1.id,
* });
* ```
*
* ## Import
*
* Floating IP associations can be imported using the `id` of the floating IP, e.g.
*
* ```sh
* $ pulumi import openstack:networking/floatingIpAssociate:FloatingIpAssociate fip 2c7f39f3-702b-48d1-940c-b50384177ee1
* ```
*/
export declare class FloatingIpAssociate extends pulumi.CustomResource {
/**
* Get an existing FloatingIpAssociate 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?: FloatingIpAssociateState, opts?: pulumi.CustomResourceOptions): FloatingIpAssociate;
/**
* Returns true if the given object is an instance of FloatingIpAssociate. 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 FloatingIpAssociate;
readonly fixedIp: pulumi.Output<string>;
/**
* IP Address of an existing floating IP.
*/
readonly floatingIp: pulumi.Output<string>;
/**
* ID of an existing port with at least one IP address to
* associate with this floating IP.
*/
readonly portId: pulumi.Output<string>;
/**
* The region in which to obtain the V2 Networking client.
* A Networking client is needed to create a floating IP that can be used with
* another networking resource, such as a load balancer. If omitted, the
* `region` argument of the provider is used. Changing this creates a new
* floating IP (which may or may not have a different address).
*/
readonly region: pulumi.Output<string>;
/**
* Create a FloatingIpAssociate 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: FloatingIpAssociateArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering FloatingIpAssociate resources.
*/
export interface FloatingIpAssociateState {
fixedIp?: pulumi.Input<string>;
/**
* IP Address of an existing floating IP.
*/
floatingIp?: pulumi.Input<string>;
/**
* ID of an existing port with at least one IP address to
* associate with this floating IP.
*/
portId?: pulumi.Input<string>;
/**
* The region in which to obtain the V2 Networking client.
* A Networking client is needed to create a floating IP that can be used with
* another networking resource, such as a load balancer. If omitted, the
* `region` argument of the provider is used. Changing this creates a new
* floating IP (which may or may not have a different address).
*/
region?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a FloatingIpAssociate resource.
*/
export interface FloatingIpAssociateArgs {
fixedIp?: pulumi.Input<string>;
/**
* IP Address of an existing floating IP.
*/
floatingIp: pulumi.Input<string>;
/**
* ID of an existing port with at least one IP address to
* associate with this floating IP.
*/
portId: pulumi.Input<string>;
/**
* The region in which to obtain the V2 Networking client.
* A Networking client is needed to create a floating IP that can be used with
* another networking resource, such as a load balancer. If omitted, the
* `region` argument of the provider is used. Changing this creates a new
* floating IP (which may or may not have a different address).
*/
region?: pulumi.Input<string>;
}