All Products
Search

This Product

    Resource Orchestration Service:VPC resources

    Document Center

    Resource Orchestration Service:VPC resources

    Last Updated:Apr 02, 2026

    AssociationProperty value

    Description

    Corresponding AssociationPropertyMetadata

    ALIYUN::VPC::EIP::AllocationId

    Retrieves information about elastic IP addresses (EIPs).

    • RegionId: The region ID. The default value is the region ID of the stack.

    • EIPStatus: The status of the EIP.

      • Associating: The EIP is being attached.

      • Unassociating: The EIP is being detached.

      • InUse: The EIP is assigned.

      • Available: The EIP is available.

      • Releasing: The resource is being released.

    Sample code

    JSON example:

    {
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "Eip": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::VPC::EIP::AllocationId",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    }
  }
}

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  Eip:
    Type: String
    AssociationProperty: ALIYUN::VPC::EIP::AllocationId
    AssociationPropertyMetadata:
      RegionId: ${RegionId}

    ALIYUN::VPC::NatGateway::NatGatewayId

    The NAT gateway ID.

    • RegionId: The region ID. The default value is the region ID of the stack.

    • ZoneId: The zone ID.

    • VpcId: The virtual private cloud (VPC) ID.

    • InstanceChargeType: The billing method of the instance.

    • NatType: The type of the NAT Gateway.

    • NetworkType: The network type of the NAT Gateway.

    Example:

    • Sample code

      JSON example:

      {
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "ZoneId": {
      "Type": "String",
      "AssociationProperty": "ZoneId",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    },
    "VpcId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::VPC::VPCId",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    },
    "NatGateway": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::VPC::NatGateway::NatGatewayId",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}",
        "ZoneId": "${ZoneId}",
        "VpcId": "${VpcId}",
        "InstanceChargeType": "PostPaid",
        "NatType": "Enhanced",
        "NetworkType": "intranet"
      }
    }
  }
}

      YAML example:

      ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  ZoneId:
    Type: String
    AssociationProperty: ZoneId
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
  VpcId:
    Type: String
    AssociationProperty: ALIYUN::ECS::VPC::VPCId
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
  NatGateway:
    Type: String
    AssociationProperty: ALIYUN::VPC::NatGateway::NatGatewayId
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
      ZoneId: ${ZoneId}
      VpcId: ${VpcId}
      InstanceChargeType: PostPaid
      NatType: Enhanced
      NetworkType: intranet

    • Example description

      In the example, the AssociationProperty property of the NatGateway parameter is set to ALIYUN::VPC::NatGateway::NatGatewayId. The AssociationPropertyMetadata property is set to RegionId, ZoneId, VpcId, InstanceChargeType, NatType, and NetworkType. This configuration retrieves the IDs of NAT gateways that match the filter conditions in the specified region.

    ALIYUN::VPC::VPC::CidrBlock

    The CIDR block for a new VPC.

    Example:

    • Sample code

      JSON example:

      {
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "CIDR": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::VPC::VPC::CidrBlock"
    }
  }
}

      YAML example:

      ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  CIDR:
    Type: String
    AssociationProperty: ALIYUN::VPC::VPC::CidrBlock

    • Example description

      In the example, the AssociationProperty property of the CIDR parameter is set to ALIYUN::VPC::VPC::CidrBlock. This configures the CIDR block for the VPC.

    ALIYUN::VPC::VSwitch::CidrBlock

    The CIDR block for a new vSwitch.

    • RegionId: The region ID. The default value is the region ID of the stack.

    • VpcId: The VPC ID.

    • VpcCidrBlock: The CIDR block of the VPC.

    Example:

    • Sample code

      JSON example:

      {
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "RegionId"
    },
    "VpcId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::VPC::VPCId",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    },
    "CIDR": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::VPC::VSwitch::CidrBlock",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}",
        "VpcId": "${VpcId}"
      }
    }
  }
}

      YAML example:

      ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: RegionId
  VpcId:
    Type: String
    AssociationProperty: ALIYUN::ECS::VPC::VPCId
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
  CIDR:
    Type: String
    AssociationProperty: ALIYUN::VPC::VSwitch::CidrBlock
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
      VpcId: ${VpcId}

    • Example description

      In the example, the AssociationProperty property of the CIDR parameter is set to ALIYUN::VPC::VSwitch::CidrBlock. The AssociationPropertyMetadata property is set to RegionId and VpcId. This configuration sets the CIDR block for the vSwitch.

    ALIYUN::VPC::VSwitch::VSwitchId

    The vSwitch ID.

    • RegionId: The region ID. The default value is the region ID of the stack.

    • ZoneId: The zone ID.

    • VpcId: The VPC ID.

    • InstanceType: The instance type.

    Example:

    • Sample code

      JSON example:

      {
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "ZoneId": {
      "Type": "String",
      "AssociationProperty": "ZoneId"
    },
    "VSwitchId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::VPC::VSwitch::VSwitchId",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}",
        "ZoneId": "${ZoneId}"
      }
    }
  }
}

      YAML example:

      ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  ZoneId:
    Type: String
    AssociationProperty: ZoneId
  VSwitchId:
    Type: String
    AssociationProperty: ALIYUN::VPC::VSwitch::VSwitchId
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
      ZoneId: ${ZoneId}

    • Example description

      In the example, by specifying the VSwitchId parameter's AssociationProperty property as ALIYUN::VPC::VSwitch::VSwitchId and its AssociationPropertyMetadata property as RegionId and ZoneId, you can retrieve the ID of the selected available vSwitch in the current region.

    ALIYUN::VPC::VirtualBorderRouter::RouteTableId

    The virtual border router (VBR) ID.

    RegionId: The region ID. The default value is the region ID of the stack.

    Example:

    • Sample code

      JSON example:

      {
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "RouteTableId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::VPC::VirtualBorderRouter::RouteTableId",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    }
  }
}

      YAML example:

      ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  RouteTableId:
    Type: String
    AssociationProperty: ALIYUN::VPC::VirtualBorderRouter::RouteTableId
    AssociationPropertyMetadata:
      RegionId: ${RegionId}

    • Example description

      In the example, the AssociationProperty property of the RouteTableId parameter is set to ALIYUN::VPC::VirtualBorderRouter::RouteTableId. The AssociationPropertyMetadata property is set to RegionId. This configuration retrieves the VBR instance IDs in the specified region.

    ALIYUN::VPC::Zone::ZoneId

    Retrieves zone information for a VPC.

    • RegionId: The region ID. The default value is the region ID of the stack.

    Sample code

    JSON example:

    {
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "ZoneId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::VPC::Zone::ZoneId",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    }
  }
}

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  ZoneId:
    Type: String
    AssociationProperty: ALIYUN::VPC::Zone::ZoneId
    AssociationPropertyMetadata:
      RegionId: ${RegionId}