Use DATASOURCE::VPC::HaVips to query the HAVIPs in a specific region - Resource Orchestration Service

DATASOURCE::VPC::HaVips is used to query the high-availability virtual IP addresses (HAVIPs) in a specific region.

Syntax

{
  "Type": "DATASOURCE::VPC::HaVips",
  "Properties": {
    "HaVipId": String,
    "RefreshOptions": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

HaVipId

String

Yes

The HAVIP ID.

None.

RefreshOptions

String

Yes

The refresh policy for data source resources when the stack is updated.

Valid values:

Never (default): does not refresh data source resources when the stack is updated.
Always: refreshes data source resources when the stack is updated.

Return values (Fn::GetAtt)

HaVipIds: the IDs of the HAVIPs.
HaVips: details of the HAVIPs.

Property	Type	Description	Constraint
HaVipIds	List	The IDs of the HAVIPs.	None.
HaVips	List	Details of the HAVIPs.	None.
Status	String	The HAVIP status.	Valid values: Creating: The HAVIP is being created. Available: The HAVIP is available. Deleting: The HAVIP is being deleted.
VpcId	String	The ID of the virtual private cloud (VPC) to which the HAVIP belongs.	None.
Description	String	The HAVIP description.	None.
AssociatedEipAddresses	String	The elastic IP addresses (EIPs) that are associated with the HAVIP.	None.
RegionId	String	The ID of the region to which the HAVIP belongs.	None.
MasterInstanceId	String	The ID of the active instance that is associated with the HAVIP.	None.
HaVipName	String	The HAVIP name.	None.
VSwitchId	String	The ID of the vSwitch to which the HAVIP belongs.	None.
HaVipId	String	The HAVIP ID.	None.
AssociatedInstanceType	String	The type of the instance with which the HAVIP is associated.	Valid values: EcsInstance: Elastic Compute Service (ECS) instance NetworkInterface: elastic network interface (ENI)
IpAddress	String	The private IP address of the HAVIP.	None.
CreateTime	String	The time when the HAVIP was created.	The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format.
AssociatedInstances	String	The IDs of the instances with which the HAVIP is associated.	None.

Examples

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "HaVipId": {
      "Type": "String",
      "Description": "The  ID of the resource"
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::VPC::HaVips",
      "Properties": {
        "HaVipId": {
          "Ref": "HaVipId"
        }
      }
    }
  },
  "Outputs": {
    "HaVips": {
      "Description": "The list of ha vips.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "HaVips"
        ]
      }
    },
    "HaVipIds": {
      "Description": "The list of ha vip IDs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "HaVipIds"
        ]
      }
    }
  }
}

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  HaVipId:
    Type: String
    Description: The  ID of the resource
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::VPC::HaVips
    Properties:
      HaVipId:
        Ref: HaVipId
Outputs:
  HaVips:
    Description: The list of ha vips.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - HaVips
  HaVipIds:
    Description: The list of ha vip IDs.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - HaVipIds