DATASOURCE::VPC::Vpcs类型用于查询已创建的VPC。

语法

{
  "Type": "DATASOURCE::VPC::Vpcs",
  "Properties": {
    "IsDefault": Boolean,
    "DhcpOptionsSetId": String,
    "ResourceGroupId": String,
    "VpcIds": List,
    "VpcName": String,
    "VpcOwnerId": String
  }
}

属性

属性名称 类型 必须 允许更新 描述 约束
IsDefault Boolean 否 是 是否查询资源栈所在地域下的默认VPC。 取值：
  • true（默认值）：查询。
  • false：不查询。
DhcpOptionsSetId String 否 是 DHCP选项集的ID。 无
ResourceGroupId String 否 是 VPC所属的资源组ID。 无
VpcIds List 否 是 VPC ID列表。 最多支持指定20个VPC ID。
VpcName String 否 是 VPC名称。 无
VpcOwnerId String 否 是 VPC所属的账号ID。 无

返回数据（Fn::GetAtt）

  • VpcIds：VPC ID列表。
  • Vpcs：VPC的详细信息。
属性名称 类型 描述 约束
VpcIds List VPC ID列表。 示例：["vpc-bp17er0y7lbw5ovjw****", "vpc-bp1ww1tfitr8bpq23****"]。
Vpcs List VPC的详细信息。 无
Status String VPC的状态。 取值：
  • Pending：配置中。
  • Available：可用。
VpcId String VPC ID。 示例：vpc-bp1qpo0kug3a20qqe****。
IsDefault Boolean 是否是该地域的默认VPC。 取值：
  • true：是默认VPC。
  • false：不是默认VPC。
OwnerId String VPC所属的阿里云账号ID。 无
VpcName String VPC的名称。 无
VRouterId String 创建VPC后，系统自动创建的路由器的ID。 示例：vrt-bp1jcg5cmxjbl9xgc****。
DhcpOptionsSetStatus String DHCP选项集的状态。 取值：
  • Available：可用。
  • InUse：使用中。
  • Deleted：已删除。
  • Pending：配置中。
CidrBlock String VPC的IPv4网段。 无
Description String VPC的描述信息。 无
ResourceGroupId String VPC所属的资源组ID。 示例：rg-acfmxazb4ph****。
DhcpOptionsSetId String DHCP选项集的ID。 示例：dopt-o6w0df4epg9zo8isy****。
Ipv6CidrBlock String VPC的IPv6网段。 无
CenStatus String VPC绑定云企业网的状态。 取值：Attached，表示已绑定。

当VPC绑定了云企业网时返回该参数。
Tags List VPC的标签信息。 示例值：
[{
    "Value": "abc",
    "Key": "test"
}]
Ipv6CidrBlocks List VPC的IPv6网段信息。 无
VSwitchIds List 交换机列表。 示例：[vsw-bp1nhbnpv2blyz8dl****]。
SecondaryCidrBlocks List VPC的附加IPv4网段。 无
UserCidrs List 用户侧网段的列表。 示例：[10.0.0.0/8]。
NatGatewayIds List NAT网关的ID。 示例：[nat-245xxxftwt45bg****]。
RouterTableIds List 路由表ID。 示例：[vtb-bp1krxxzp0c29fmon****]。

示例

JSON格式 

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "VpcName": {
      "Type": "String",
      "Description": "The name of the VPC.",
      "Default": "TestVpc"
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::VPC::Vpcs",
      "Properties": {
        "VpcName": {
          "Ref": "VpcName"
        }
      }
    }
  },
  "Outputs": {
    "Vpcs": {
      "Description": "The detailed information about the VPCs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Vpcs"
        ]
      }
    },
    "VpcIds": {
      "Description": "The list of The VPC IDs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VpcIds"
        ]
      }
    }
  }
}