index

title: "Vip" title_tag: "huaweicloud.Vpc.Vip" meta_desc: "Documentation for the huaweicloud.Vpc.Vip resource with examples, input properties, output properties, lookup functions, and supporting types." layout: api no_edit_this_page: true

Manages a network VIP resource within HuaweiCloud VPC.

Create Vip Resource {#create}

new Vip(name: string, args: VipArgs, opts?: CustomResourceOptions);

@overload
def Vip(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        ip_address: Optional[str] = None,
        ip_version: Optional[int] = None,
        name: Optional[str] = None,
        network_id: Optional[str] = None,
        region: Optional[str] = None,
        subnet_id: Optional[str] = None)
@overload
def Vip(resource_name: str,
        args: VipArgs,
        opts: Optional[ResourceOptions] = None)

func NewVip(ctx *Context, name string, args VipArgs, opts ...ResourceOption) (*Vip, error)

public Vip(string name, VipArgs args, CustomResourceOptions? opts = null)

public Vip(String name, VipArgs args)
public Vip(String name, VipArgs args, CustomResourceOptions options)

type: huaweicloud:Vpc:Vip
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args VipArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args VipArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args VipArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args VipArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args VipArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Vip Resource Properties {#properties}

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Vip resource accepts the following input properties:

NetworkId string

Specifies the network ID of the VPC subnet to which the VIP belongs. Changing this will create a new VIP resource.

IpAddress string

Specifies the IP address desired in the subnet for this VIP. Changing this will create a new VIP resource.

IpVersion int

Specifies the IP version, either 4 (default) or 6. Changing this will create a new VIP resource.

Name string

Specifies a unique name for the VIP.

Region string

Specifies the region in which to create the VIP. If omitted, the provider-level region will be used. Changing this will create a new VIP resource.

SubnetId string

The subnet ID in which to allocate IP address for this VIP.

Deprecated:

use ip_version instead

NetworkId string

Specifies the network ID of the VPC subnet to which the VIP belongs. Changing this will create a new VIP resource.

IpAddress string

Specifies the IP address desired in the subnet for this VIP. Changing this will create a new VIP resource.

IpVersion int

Specifies the IP version, either 4 (default) or 6. Changing this will create a new VIP resource.

Name string

Specifies a unique name for the VIP.

Region string

Specifies the region in which to create the VIP. If omitted, the provider-level region will be used. Changing this will create a new VIP resource.

SubnetId string

The subnet ID in which to allocate IP address for this VIP.

Deprecated:

use ip_version instead

networkId String

Specifies the network ID of the VPC subnet to which the VIP belongs. Changing this will create a new VIP resource.

ipAddress String

Specifies the IP address desired in the subnet for this VIP. Changing this will create a new VIP resource.

ipVersion Integer

Specifies the IP version, either 4 (default) or 6. Changing this will create a new VIP resource.

name String

Specifies a unique name for the VIP.

region String

Specifies the region in which to create the VIP. If omitted, the provider-level region will be used. Changing this will create a new VIP resource.

subnetId String

The subnet ID in which to allocate IP address for this VIP.

Deprecated:

use ip_version instead

networkId string

Specifies the network ID of the VPC subnet to which the VIP belongs. Changing this will create a new VIP resource.

ipAddress string

Specifies the IP address desired in the subnet for this VIP. Changing this will create a new VIP resource.

ipVersion number

Specifies the IP version, either 4 (default) or 6. Changing this will create a new VIP resource.

name string

Specifies a unique name for the VIP.

region string

Specifies the region in which to create the VIP. If omitted, the provider-level region will be used. Changing this will create a new VIP resource.

subnetId string

The subnet ID in which to allocate IP address for this VIP.

Deprecated:

use ip_version instead

network_id str

Specifies the network ID of the VPC subnet to which the VIP belongs. Changing this will create a new VIP resource.

ip_address str

Specifies the IP address desired in the subnet for this VIP. Changing this will create a new VIP resource.

ip_version int

Specifies the IP version, either 4 (default) or 6. Changing this will create a new VIP resource.

name str

Specifies a unique name for the VIP.

region str

Specifies the region in which to create the VIP. If omitted, the provider-level region will be used. Changing this will create a new VIP resource.

subnet_id str

The subnet ID in which to allocate IP address for this VIP.

Deprecated:

use ip_version instead

networkId String

Specifies the network ID of the VPC subnet to which the VIP belongs. Changing this will create a new VIP resource.

ipAddress String

Specifies the IP address desired in the subnet for this VIP. Changing this will create a new VIP resource.

ipVersion Number

Specifies the IP version, either 4 (default) or 6. Changing this will create a new VIP resource.

name String

Specifies a unique name for the VIP.

region String

Specifies the region in which to create the VIP. If omitted, the provider-level region will be used. Changing this will create a new VIP resource.

subnetId String

The subnet ID in which to allocate IP address for this VIP.

Deprecated:

use ip_version instead

Outputs

All input properties are implicitly available as output properties. Additionally, the Vip resource produces the following output properties:

DeviceOwner string: The device owner of the VIP.
Id string: The provider-assigned unique ID for this managed resource.
MacAddress string: The MAC address of the VIP.
Status string: The VIP status.

DeviceOwner string: The device owner of the VIP.
Id string: The provider-assigned unique ID for this managed resource.
MacAddress string: The MAC address of the VIP.
Status string: The VIP status.

deviceOwner String: The device owner of the VIP.
id String: The provider-assigned unique ID for this managed resource.
macAddress String: The MAC address of the VIP.
status String: The VIP status.

deviceOwner string: The device owner of the VIP.
id string: The provider-assigned unique ID for this managed resource.
macAddress string: The MAC address of the VIP.
status string: The VIP status.

device_owner str: The device owner of the VIP.
id str: The provider-assigned unique ID for this managed resource.
mac_address str: The MAC address of the VIP.
status str: The VIP status.

deviceOwner String: The device owner of the VIP.
id String: The provider-assigned unique ID for this managed resource.
macAddress String: The MAC address of the VIP.
status String: The VIP status.

Look up Existing Vip Resource {#look-up}

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

public static get(name: string, id: Input<ID>, state?: VipState, opts?: CustomResourceOptions): Vip

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        device_owner: Optional[str] = None,
        ip_address: Optional[str] = None,
        ip_version: Optional[int] = None,
        mac_address: Optional[str] = None,
        name: Optional[str] = None,
        network_id: Optional[str] = None,
        region: Optional[str] = None,
        status: Optional[str] = None,
        subnet_id: Optional[str] = None) -> Vip

func GetVip(ctx *Context, name string, id IDInput, state *VipState, opts ...ResourceOption) (*Vip, error)

public static Vip Get(string name, Input<string> id, VipState? state, CustomResourceOptions? opts = null)

public static Vip get(String name, Output<String> id, VipState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

DeviceOwner string

The device owner of the VIP.

IpAddress string

Specifies the IP address desired in the subnet for this VIP. Changing this will create a new VIP resource.

IpVersion int

Specifies the IP version, either 4 (default) or 6. Changing this will create a new VIP resource.

MacAddress string

The MAC address of the VIP.

Name string

Specifies a unique name for the VIP.

NetworkId string

Specifies the network ID of the VPC subnet to which the VIP belongs. Changing this will create a new VIP resource.

Region string

Specifies the region in which to create the VIP. If omitted, the provider-level region will be used. Changing this will create a new VIP resource.

Status string

The VIP status.

SubnetId string

The subnet ID in which to allocate IP address for this VIP.

Deprecated:

use ip_version instead

DeviceOwner string

The device owner of the VIP.

IpAddress string

Specifies the IP address desired in the subnet for this VIP. Changing this will create a new VIP resource.

IpVersion int

Specifies the IP version, either 4 (default) or 6. Changing this will create a new VIP resource.

MacAddress string

The MAC address of the VIP.

Name string

Specifies a unique name for the VIP.

NetworkId string

Specifies the network ID of the VPC subnet to which the VIP belongs. Changing this will create a new VIP resource.

Region string

Specifies the region in which to create the VIP. If omitted, the provider-level region will be used. Changing this will create a new VIP resource.

Status string

The VIP status.

SubnetId string

The subnet ID in which to allocate IP address for this VIP.

Deprecated:

use ip_version instead

deviceOwner String

The device owner of the VIP.

ipAddress String

Specifies the IP address desired in the subnet for this VIP. Changing this will create a new VIP resource.

ipVersion Integer

Specifies the IP version, either 4 (default) or 6. Changing this will create a new VIP resource.

macAddress String

The MAC address of the VIP.

name String

Specifies a unique name for the VIP.

networkId String

Specifies the network ID of the VPC subnet to which the VIP belongs. Changing this will create a new VIP resource.

region String

Specifies the region in which to create the VIP. If omitted, the provider-level region will be used. Changing this will create a new VIP resource.

status String

The VIP status.

subnetId String

The subnet ID in which to allocate IP address for this VIP.

Deprecated:

use ip_version instead

deviceOwner string

The device owner of the VIP.

ipAddress string

Specifies the IP address desired in the subnet for this VIP. Changing this will create a new VIP resource.

ipVersion number

Specifies the IP version, either 4 (default) or 6. Changing this will create a new VIP resource.

macAddress string

The MAC address of the VIP.

name string

Specifies a unique name for the VIP.

networkId string

Specifies the network ID of the VPC subnet to which the VIP belongs. Changing this will create a new VIP resource.

region string

Specifies the region in which to create the VIP. If omitted, the provider-level region will be used. Changing this will create a new VIP resource.

status string

The VIP status.

subnetId string

The subnet ID in which to allocate IP address for this VIP.

Deprecated:

use ip_version instead

device_owner str

The device owner of the VIP.

ip_address str

Specifies the IP address desired in the subnet for this VIP. Changing this will create a new VIP resource.

ip_version int

Specifies the IP version, either 4 (default) or 6. Changing this will create a new VIP resource.

mac_address str

The MAC address of the VIP.

name str

Specifies a unique name for the VIP.

network_id str

Specifies the network ID of the VPC subnet to which the VIP belongs. Changing this will create a new VIP resource.

region str

Specifies the region in which to create the VIP. If omitted, the provider-level region will be used. Changing this will create a new VIP resource.

status str

The VIP status.

subnet_id str

The subnet ID in which to allocate IP address for this VIP.

Deprecated:

use ip_version instead

deviceOwner String

The device owner of the VIP.

ipAddress String

Specifies the IP address desired in the subnet for this VIP. Changing this will create a new VIP resource.

ipVersion Number

Specifies the IP version, either 4 (default) or 6. Changing this will create a new VIP resource.

macAddress String

The MAC address of the VIP.

name String

Specifies a unique name for the VIP.

networkId String

Specifies the network ID of the VPC subnet to which the VIP belongs. Changing this will create a new VIP resource.

region String

Specifies the region in which to create the VIP. If omitted, the provider-level region will be used. Changing this will create a new VIP resource.

status String

The VIP status.

subnetId String

The subnet ID in which to allocate IP address for this VIP.

Deprecated:

use ip_version instead

Import

Network VIPs can be imported using their id, e.g.

 $ pulumi import huaweicloud:Vpc/vip:Vip test ce595799-da26-4015-8db5-7733c6db292e

Package Details

Repository: https://github.com/huaweicloud/pulumi-huaweicloud
License: Apache-2.0
Notes: This Pulumi package is based on the huaweicloud Terraform Provider.