@pulumi/openstack
Version:
A Pulumi package for creating and managing OpenStack cloud resources.
180 lines (179 loc) • 7.41 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Manages a V2 portforwarding resource within OpenStack.
*
* ## Example Usage
*
* ### Simple portforwarding
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as openstack from "@pulumi/openstack";
*
* const pf1 = new openstack.networking.PortForwardingV2("pf_1", {
* floatingipId: "7a52eb59-7d47-415d-a884-046666a6fbae",
* externalPort: 7233,
* internalPort: 25,
* internalPortId: "b930d7f6-ceb7-40a0-8b81-a425dd994ccf",
* protocol: "tcp",
* });
* ```
*/
export declare class PortForwardingV2 extends pulumi.CustomResource {
/**
* Get an existing PortForwardingV2 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?: PortForwardingV2State, opts?: pulumi.CustomResourceOptions): PortForwardingV2;
/**
* Returns true if the given object is an instance of PortForwardingV2. 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 PortForwardingV2;
/**
* A text describing the port forwarding. Changing this
* updates the `description` of an existing port forwarding.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The TCP/UDP/other protocol port number of the port forwarding. Changing this
* updates the `externalPort` of an existing port forwarding.
*/
readonly externalPort: pulumi.Output<number>;
/**
* The ID of the Neutron floating IP address. Changing this creates a new port forwarding.
*/
readonly floatingipId: pulumi.Output<string>;
/**
* The fixed IPv4 address of the Neutron port associated with the port forwarding.
* Changing this updates the `internalIpAddress` of an existing port forwarding.
*/
readonly internalIpAddress: pulumi.Output<string>;
/**
* The TCP/UDP/other protocol port number of the Neutron port fixed IP address associated to the
* port forwarding. Changing this updates the `internalPort` of an existing port forwarding.
*/
readonly internalPort: pulumi.Output<number>;
/**
* The ID of the Neutron port associated with the port forwarding. Changing
* this updates the `internalPortId` of an existing port forwarding.
*/
readonly internalPortId: pulumi.Output<string>;
/**
* The IP protocol used in the port forwarding. Changing this updates the `protocol`
* of an existing port forwarding.
*/
readonly protocol: pulumi.Output<string>;
/**
* The region in which to obtain the V2 networking client.
* A networking client is needed to create a port forwarding. If omitted, the
* `region` argument of the provider is used. Changing this creates a new
* port forwarding.
*/
readonly region: pulumi.Output<string>;
/**
* Create a PortForwardingV2 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: PortForwardingV2Args, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering PortForwardingV2 resources.
*/
export interface PortForwardingV2State {
/**
* A text describing the port forwarding. Changing this
* updates the `description` of an existing port forwarding.
*/
description?: pulumi.Input<string>;
/**
* The TCP/UDP/other protocol port number of the port forwarding. Changing this
* updates the `externalPort` of an existing port forwarding.
*/
externalPort?: pulumi.Input<number>;
/**
* The ID of the Neutron floating IP address. Changing this creates a new port forwarding.
*/
floatingipId?: pulumi.Input<string>;
/**
* The fixed IPv4 address of the Neutron port associated with the port forwarding.
* Changing this updates the `internalIpAddress` of an existing port forwarding.
*/
internalIpAddress?: pulumi.Input<string>;
/**
* The TCP/UDP/other protocol port number of the Neutron port fixed IP address associated to the
* port forwarding. Changing this updates the `internalPort` of an existing port forwarding.
*/
internalPort?: pulumi.Input<number>;
/**
* The ID of the Neutron port associated with the port forwarding. Changing
* this updates the `internalPortId` of an existing port forwarding.
*/
internalPortId?: pulumi.Input<string>;
/**
* The IP protocol used in the port forwarding. Changing this updates the `protocol`
* of an existing port forwarding.
*/
protocol?: pulumi.Input<string>;
/**
* The region in which to obtain the V2 networking client.
* A networking client is needed to create a port forwarding. If omitted, the
* `region` argument of the provider is used. Changing this creates a new
* port forwarding.
*/
region?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a PortForwardingV2 resource.
*/
export interface PortForwardingV2Args {
/**
* A text describing the port forwarding. Changing this
* updates the `description` of an existing port forwarding.
*/
description?: pulumi.Input<string>;
/**
* The TCP/UDP/other protocol port number of the port forwarding. Changing this
* updates the `externalPort` of an existing port forwarding.
*/
externalPort: pulumi.Input<number>;
/**
* The ID of the Neutron floating IP address. Changing this creates a new port forwarding.
*/
floatingipId: pulumi.Input<string>;
/**
* The fixed IPv4 address of the Neutron port associated with the port forwarding.
* Changing this updates the `internalIpAddress` of an existing port forwarding.
*/
internalIpAddress: pulumi.Input<string>;
/**
* The TCP/UDP/other protocol port number of the Neutron port fixed IP address associated to the
* port forwarding. Changing this updates the `internalPort` of an existing port forwarding.
*/
internalPort: pulumi.Input<number>;
/**
* The ID of the Neutron port associated with the port forwarding. Changing
* this updates the `internalPortId` of an existing port forwarding.
*/
internalPortId: pulumi.Input<string>;
/**
* The IP protocol used in the port forwarding. Changing this updates the `protocol`
* of an existing port forwarding.
*/
protocol: pulumi.Input<string>;
/**
* The region in which to obtain the V2 networking client.
* A networking client is needed to create a port forwarding. If omitted, the
* `region` argument of the provider is used. Changing this creates a new
* port forwarding.
*/
region?: pulumi.Input<string>;
}