DATASOURCE::VPC::HaVip - Resource Orchestration Service - Alibaba Cloud Documentation Center

DATASOURCE::VPC::HaVip is used to query a high-availability virtual IP address (HAVIP).

Syntax

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

Properties

Property

Type

Required

Editable

Description

Constraint

HaVipId

String

Yes

The ID of the HAVIP.

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

AssociatedInstances: the information about the instances associated with the HAVIP.
Description: the description of the HAVIP.
VpcId: the ID of the virtual private cloud (VPC) to which the HAVIP belongs.
AssociatedEipAddresses: the elastic IP addresses (EIPs) associated with the HAVIP.
MasterInstanceId: the primary instance ID associated with the HAVIP.
VSwitchId: the vSwitch ID of the HAVIP.
CreateTime: the time when the HAVIP was created.
HaVipName: the name of the HAVIP.
IpAddress: the private IP address of the HAVIP.
HaVipId: the ID of the HAVIP.
AssociatedInstanceType: the instance type associated with the HAVIP.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  HaVipId:
    Type: String
    Description:
      en: The  ID of the resource.
    Required: true
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::VPC::HaVip
    Properties:
      HaVipId:
        Ref: HaVipId
Outputs:
  AssociatedInstances:
    Description: An ECS instance that is bound to HaVip.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - AssociatedInstances
  Description:
    Description: Dependence of a HaVip instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Description
  VpcId:
    Description: The VPC ID to which the HaVip instance belongs.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - VpcId
  AssociatedEipAddresses:
    Description: EIP bound to HaVip.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - AssociatedEipAddresses
  MasterInstanceId:
    Description: The primary instance ID bound to HaVip.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - MasterInstanceId
  VSwitchId:
    Description: The switch ID to which the HaVip instance belongs.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - VSwitchId
  CreateTime:
    Description: The creation time of the  resource.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CreateTime
  HaVipName:
    Description: The name of the HaVip instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - HaVipName
  IpAddress:
    Description: IP address of private network.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - IpAddress
  HaVipId:
    Description: The  ID of the resource.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - HaVipId
  AssociatedInstanceType:
    Description: The type of the instance that is bound to the VIIP.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - AssociatedInstanceType

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "HaVipId": {
      "Type": "String",
      "Description": {
        "en": "The  ID of the resource."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::VPC::HaVip",
      "Properties": {
        "HaVipId": {
          "Ref": "HaVipId"
        }
      }
    }
  },
  "Outputs": {
    "AssociatedInstances": {
      "Description": "An ECS instance that is bound to HaVip.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AssociatedInstances"
        ]
      }
    },
    "Description": {
      "Description": "Dependence of a HaVip instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Description"
        ]
      }
    },
    "VpcId": {
      "Description": "The VPC ID to which the HaVip instance belongs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VpcId"
        ]
      }
    },
    "AssociatedEipAddresses": {
      "Description": "EIP bound to HaVip.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AssociatedEipAddresses"
        ]
      }
    },
    "MasterInstanceId": {
      "Description": "The primary instance ID bound to HaVip.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "MasterInstanceId"
        ]
      }
    },
    "VSwitchId": {
      "Description": "The switch ID to which the HaVip instance belongs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VSwitchId"
        ]
      }
    },
    "CreateTime": {
      "Description": "The creation time of the  resource.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreateTime"
        ]
      }
    },
    "HaVipName": {
      "Description": "The name of the HaVip instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "HaVipName"
        ]
      }
    },
    "IpAddress": {
      "Description": "IP address of private network.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "IpAddress"
        ]
      }
    },
    "HaVipId": {
      "Description": "The  ID of the resource.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "HaVipId"
        ]
      }
    },
    "AssociatedInstanceType": {
      "Description": "The type of the instance that is bound to the VIIP.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AssociatedInstanceType"
        ]
      }
    }
  }
}