Show / Hide Table of Contents

Class FloatingIp

Manages a V2 floating IP resource within OpenStack Neutron (networking) that can be used for load balancers. These are similar to Nova (compute) floating IP resources, but only compute floating IPs can be used with compute instances.

Example Usage

using Pulumi;
using OpenStack = Pulumi.OpenStack;

class MyStack : Stack
{
public MyStack()
{
    var floatip1 = new OpenStack.Networking.FloatingIp("floatip1", new OpenStack.Networking.FloatingIpArgs
    {
        Pool = "public",
    });
}

}
Inheritance
System.Object
Resource
CustomResource
FloatingIp
Inherited Members
CustomResource.Id
Resource.GetResourceType()
Resource.GetResourceName()
Resource.Urn
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Pulumi.OpenStack.Networking
Assembly: Pulumi.OpenStack.dll
Syntax
public class FloatingIp : CustomResource

Constructors

View Source

FloatingIp(String, FloatingIpArgs, CustomResourceOptions)

Create a FloatingIp resource with the given unique name, arguments, and options.

Declaration
public FloatingIp(string name, FloatingIpArgs args, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resource

FloatingIpArgs args

The arguments used to populate this resource's properties

CustomResourceOptions options

A bag of options that control this resource's behavior

Properties

View Source

Address

The actual/specific floating IP to obtain. By default, non-admin users are not able to specify a floating IP, so you must either be an admin user or have had a custom policy or role applied to your OpenStack user or project.

Declaration
public Output<string> Address { get; }
Property Value
Type Description
Output<System.String>
View Source

AllTags

The collection of tags assigned on the floating IP, which have been explicitly and implicitly added.

Declaration
public Output<ImmutableArray<string>> AllTags { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>
View Source

Description

Human-readable description for the floating IP.

Declaration
public Output<string> Description { get; }
Property Value
Type Description
Output<System.String>
View Source

DnsDomain

The floating IP DNS domain. Available, when Neutron DNS extension is enabled. The data in this attribute will be published in an external DNS service when Neutron is configured to integrate with such a service. Changing this creates a new floating IP.

Declaration
public Output<string> DnsDomain { get; }
Property Value
Type Description
Output<System.String>
View Source

DnsName

The floating IP DNS name. Available, when Neutron DNS extension is enabled. The data in this attribute will be published in an external DNS service when Neutron is configured to integrate with such a service. Changing this creates a new floating IP.

Declaration
public Output<string> DnsName { get; }
Property Value
Type Description
Output<System.String>
View Source

FixedIp

Fixed IP of the port to associate with this floating IP. Required if the port has multiple fixed IPs.

Declaration
public Output<string> FixedIp { get; }
Property Value
Type Description
Output<System.String>
View Source

Pool

The name of the pool from which to obtain the floating IP. Changing this creates a new floating IP.

Declaration
public Output<string> Pool { get; }
Property Value
Type Description
Output<System.String>
View Source

PortId

ID of an existing port with at least one IP address to associate with this floating IP.

Declaration
public Output<string> PortId { get; }
Property Value
Type Description
Output<System.String>
View Source

Region

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).

Declaration
public Output<string> Region { get; }
Property Value
Type Description
Output<System.String>
View Source

SubnetId

The subnet ID of the floating IP pool. Specify this if the floating IP network has multiple subnets.

Declaration
public Output<string> SubnetId { get; }
Property Value
Type Description
Output<System.String>
View Source

Tags

A set of string tags for the floating IP.

Declaration
public Output<ImmutableArray<string>> Tags { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>
View Source

TenantId

The target tenant ID in which to allocate the floating IP, if you specify this together with a port_id, make sure the target port belongs to the same tenant. Changing this creates a new floating IP (which may or may not have a different address)

Declaration
public Output<string> TenantId { get; }
Property Value
Type Description
Output<System.String>
View Source

ValueSpecs

Map of additional options.

Declaration
public Output<ImmutableDictionary<string, object>> ValueSpecs { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

Methods

View Source

Get(String, Input<String>, FloatingIpState, CustomResourceOptions)

Get an existing FloatingIp resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration
public static FloatingIp Get(string name, Input<string> id, FloatingIpState state = null, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resulting resource.

Input<System.String> id

The unique provider ID of the resource to lookup.

FloatingIpState state

Any extra arguments used during the lookup.

CustomResourceOptions options

A bag of options that control this resource's behavior

Returns
Type Description
FloatingIp
  • View Source
Back to top Copyright 2016-2020, Pulumi Corporation.